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

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

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

wants to merge 1 commit into from

Conversation

aimeeu
Copy link
Contributor

@aimeeu aimeeu commented Aug 26, 2020

clarify that in basic mode, you must install Spinnaker in the spinnaker-operator namespace

@armory-jenkins
Copy link

The title of this Pull Request needs to be changed to match the format:

<type>(<scope>): <subject>

See more details here: https://www.spinnaker.io/community/contributing/submitting/#commit-message-conventions

Some common examples are:

feat(armory.io): add docs.armory.io
fix(parser): grammar and spelling
style(loadingPage): made it super pretty!
refactor(helpMessages): changed order to make more sense

@aimeeu aimeeu changed the title Update README - clarify basic vs cluster install docs(fix): Update README - clarify basic vs cluster install Aug 26, 2020
@coveralls
Copy link

Pull Request Test Coverage Report for Build 225552164

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 34.721%
Totals Coverage Status
Change from base Build 214397227: 0.0%
Covered Lines: 1876
Relevant Lines: 5403
💛 - Coveralls

ncknt
ncknt reviewed Aug 28, 2020
View reviewed changes
README.md

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo OperAtor

ncknt
ncknt reviewed Aug 28, 2020
View reviewed changes
README.md
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`.
Copy link
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.

Copy link

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?

ncknt
ncknt reviewed Aug 28, 2020
View reviewed changes
README.md
### 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.
Copy link
Contributor

@ncknt ncknt Aug 28, 2020 •
edited
Loading

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasonmcintosh jasonmcintosh jasonmcintosh left review comments

+1 more reviewer

@ncknt ncknt ncknt left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aimeeu @armory-jenkins @coveralls @ncknt @jasonmcintosh