Skip to content

docs(fix): Update README - clarify basic vs cluster install #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aimeeu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(fix): Update README - clarify basic vs cluster install #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,22 +89,21 @@ Note: `SpinnakerAccount` CRD is optional.
### Step 2: Install Operator

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.

@ncknt ncknt Aug 28, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo OperAtor

- **Cluster mode** works across namespaces and requires a `ClusterRole` to perform validation.

The main difference between the two modes is that basic only requires a `Role` (vs a `ClusterRole`) and has no validating 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`.
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`.

@ncknt ncknt Aug 28, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would make more sense to me to use spinnaker as the namespace. That's the main thing the namespace contains.

@jasonmcintosh jasonmcintosh Aug 28, 2020

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

To install Operator run:

```bash
$ kubectl apply -n <namespace> -f deploy/operator/basic
$ kubectl apply -n spinnaker-operator -f deploy/operator/basic
```

`namespace` is the namespace where you want the operator to live and deploy to.

#### Cluster install
To install Operator:
1. Decide what namespace you want to use for Operator and create that namespace. We suggest `spinnaker-operator`.
Expand All @@ -126,11 +125,10 @@ Spinnaker. It is likely different from the operator's namespace.

### 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.

@ncknt ncknt Aug 28, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you must use the spinnaker-operator namespace

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.


```bash
$ kubectl create ns <spinnaker-namespace>
$ kubectl -n <spinnaker-namespace> apply -f deploy/spinnaker/basic/spinnakerservice.yml
$ $ kubectl -n spinnaker-operator apply -f deploy/spinnaker/basic/spinnakerservice.yml
```

This configuration does not contain any connected accounts, just a persistent storage.
Expand Down