docs(fix): Update README - clarify basic vs cluster install#165
docs(fix): Update README - clarify basic vs cluster install#165
Conversation
|
The title of this Pull Request needs to be changed to match the format: See more details here: https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions Some common examples are: |
Pull Request Test Coverage Report for Build 225552164
💛 - Coveralls |
|
|
||
| There are two modes for the operator: | ||
| - **Basic mode** installs Spinnaker in a single namespace without validating admission webhook. | ||
| - **Basic mode** installs Spinnaker into the same namespace as the Spinnaker Opertor without validating admission webhook. |
| Once installed, you should see a new deployment representing the Operator. The Operator watches for changes to the `SpinnakerService` objects. You can check on the status of the Operator using `kubectl`. | ||
|
|
||
| #### Basic install (no validating webhook) | ||
| Decide what namespace you want to use for Operator and create that namespace. We suggest `spinnaker-operator`. |
There was a problem hiding this comment.
It would make more sense to me to use spinnaker as the namespace. That's the main thing the namespace contains.
There was a problem hiding this comment.
Note, we actually have MOST of our automation setup to use "spinnaker" as where spinnaker itself is deployed to and spinnaker-operator as where operator is deployed to. Should spinnaker operator be in "spinnaker" and there be a different standard for spinnaker itself?
| ### Example 1: Basic Install | ||
|
|
||
| In `deploy/spinnaker/basic/spinnakerservice.yml`, change the `config.persistentStorage` section to point to an S3 bucket you own or use a different persistent storage. Also make sure to update the Spinnaker version to the [desired version](https://www.spinnaker.io/community/releases/versions/#latest-stable). | ||
| In `deploy/spinnaker/basic/spinnakerservice.yml`, change the `config.persistentStorage` section to point to an S3 bucket you own or use a different persistent storage. Also make sure to update the Spinnaker version to the [desired version](https://www.spinnaker.io/community/releases/versions/#latest-stable). Since you installed Operator in `basic` mode, you must use the `spinnaker-operator` namespace. The permissions in `basic` mode are scoped to a single namespace so it doesn't see anything in other namespaces. |
There was a problem hiding this comment.
you must use the
spinnaker-operatornamespace
There's no technical reason for that. In basic mode, you can specify the namespace on the command line (kubectl create ns blah && kubectl -n blah apply -f deploy/operator/basic && kubectl -n blah apply -f deploy/spinnaker/basic/spinnakerservice.yml). In cluster mode, the namespace is also in the role binding, that's why we strongly suggest spinnaker-operator as a default.
clarify that in basic mode, you must install Spinnaker in the spinnaker-operator namespace