Add the Kubernetes Operator install instructions #1017
Merged
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
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
3 - Tech review
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
4 - Doc review
alicejw1
reviewed
Sep 14, 2022
alicejw1
reviewed
Sep 14, 2022
alicejw1
reviewed
Sep 14, 2022
alicejw1
approved these changes
Sep 14, 2022
cwillum
reviewed
Sep 14, 2022
cwillum
reviewed
Sep 14, 2022
cwillum
reviewed
Sep 14, 2022
cwillum
reviewed
Sep 14, 2022
cwillum
approved these changes
Sep 14, 2022
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
5 - Editorial review
natebower
reviewed
Sep 16, 2022
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and let me know if you have any questions. Thanks!
_clients/k8s-operator.md
Outdated
|
|
||
| If you use Helm to manage your K8s cluster, you can use the OpenSearch Kubernetes Operator's CNCF project stored in Artifact Hub, a web-based application for finding, installing, and publishing CNCF packages. | ||
|
|
||
| To begin, log into your K8s cluster and add the Helm repository (repo) from [Artifact Hub](https://opster.github.io/opensearch-k8s-operator/). |
There was a problem hiding this comment.
Change "into" to "in to".
Signed-off-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0)
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0)
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0)
Naarcha-AWS
added a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0) Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0) Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0) Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0)
Naarcha-AWS
added a commit
that referenced
this pull request
Sep 21, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit a6e47e0) Co-authored-by: Naarcha-AWS <[email protected]>
rursprung
reviewed
Sep 22, 2022
| apiVersion: v1 | ||
| clusters: | ||
| - cluster: | ||
| certificate-authority: /Users/naarcha/.minikube/ca.crt |
There was a problem hiding this comment.
you shouldn't include real paths / usernames in the documentation, it provides no added value and just causes confusion. (same applies to the other 2 places where you have your username in the example file)
| 1. In your preferred directory, clone the [OpenSearch Kubernetes Operator repo](https://github.com/Opster/opensearch-k8s-operator). Navigate into repo's directory using `cd`. | ||
| 2. Go to the `opensearch-operator` folder. | ||
| 3. Enter `make build manifests`. | ||
| 4. Start a Kubernetes cluster. When using minikube, open a new terminal window and enter `minikube start`. Kubernetes will now use a containerized minikube cluster with a namespace called `default`. Make sure that `~/.kube/config` points to the cluster. |
There was a problem hiding this comment.
this is mostly the same sentence as on line 54. maybe combine them?
|
|
||
| After the installation completes, the operator returns information on the deployment with `STATUS: deployed`. Then you can configure and start your [OpenSearch cluster](#deploy-a-new-opensearch-cluster). | ||
|
|
||
| ### Use a local installation |
There was a problem hiding this comment.
why can't you use the helm chart just because you're running a local minikube cluster? i think these are separate topics:
- how you run your k8s cluster (real cluster vs. minikube)
- how you deploy the operator (helm vs. self-built)
| In order to delete the OpenSearch cluster, delete the cluster resources. The following command deletes the cluster namespace and all its resources. | ||
|
|
||
| ``` | ||
| kubectl delete -f opensearch-cluster.yaml |
There was a problem hiding this comment.
if this also deletes the PVCs (= the data) then you should add a big fat warning as this will be a non-reversible option with data loss (which may or may not be intentional)!
|
|
||
| With the Kubernetes cluster running, you can now run OpenSearch inside the cluster. | ||
|
|
||
| ## Deploy a new OpenSearch cluster |
There was a problem hiding this comment.
it should be clearly noted that these are purely examples and are not production ready (using demo TLS certificates, etc.)
| The operator creates several pods, including a bootstrap pod, three OpenSearch cluster pods, and one Dashboards pod. To connect to your cluster, use the `port-forward` command. | ||
|
|
||
| ``` | ||
| kubectl port-forward svc/my-cluster-dashboards 5601 |
There was a problem hiding this comment.
while i hope that people using k8s are aware of this, it might be worth noting that this is only done for demo purposes; in a real setup an Ingress resource (or Route on OpenShift) must be set up to have a proper route available and not rely on port-forwarding
Naarcha-AWS
added a commit
that referenced
this pull request
Oct 6, 2022
* Add the Kubernetes Operator install instructions Signed-off-by: Naarcha-AWS <[email protected]> * Copy edits Signed-off-by: Naarcha-AWS <[email protected]> * Add doc review Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
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.
Signed-off-by: Naarcha-AWS [email protected]
Fixes #562
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.