Adding GettingStarted page and structuring docs for website #101
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kvahed
requested changes
Apr 3, 2018
| Starting an ArangoDB database (either single server or full blown cluster) | ||
| on Kubernetes involves a lot of resources. | ||
|
|
||
| The servers needs to run in Pods, you need secrets for authentication, |
There was a problem hiding this comment.
small p for pods and s in services. execpt you wanted to write Pods and Services
| provide `PersistenVolume's` on local storage of your nodes for optimal | ||
| storage performace. | ||
|
|
||
| Note that the operator that provides `PersistentVolume's` is not needed to |
| ## Installing `kube-arangodb` | ||
|
|
||
| To install `kube-arangodb` in your Kubernetes cluster, make sure | ||
| you have acces to this cluster and the rights to deployment resources |
There was a problem hiding this comment.
deploy instead of deployment?
|
|
||
| Then run (replace `<version>` with the version of the operator that you want to install): | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Yes, it sets the correct syntax highligher
| kubectl apply -f https://raw.githubusercontent.com/arangodb/kube-arangodb/<version>/manifests/arango-deployment.yaml | ||
| ``` | ||
|
|
||
| The first command installs two `CustomResourceDefinition's` in your Kubernetes cluster: |
There was a problem hiding this comment.
Check all plurals. They all go without '
| kubectl get pods --selector=arango_deployment=single-server | ||
| ``` | ||
|
|
||
| The result will looks something like this: |
| kubectl describe arango single-server | ||
| ``` | ||
|
|
||
| To inspect the pods created for this deployment, run: |
There was a problem hiding this comment.
Don't like it without comma. Are you really sure?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a Getting Started guide and structures
the user documentation such that is matches the structure
needed for docs.arangodb.com.