docs(install): Work on a redo of the installation docs #362
Conversation
… and remove some old configuration
…ed old install links
| you just want to evaluate Spinnaker without much work, one of the options in | ||
| [Quickstart](/docs/setup/quickstart/) or a [Local installation](/docs/setup/install/local/) might be | ||
| a better choice. It's recommended that you review the [spinnaker architecture](/docs/reference/architecture) | ||
| to understand how spinnaker operates before installation. |
There was a problem hiding this comment.
I would simplify it more
Before installing, review Spinnaker's architecture
| * [Distributed installation](#distributed-installation) on Kubernetes | ||
|
|
||
| Halyard deploys each of Spinnaker's | ||
| separately. __This is highly recommended for use in production.__ |
There was a problem hiding this comment.
suggestion Highly recommended for production
|
|
||
| ## What you'll need | ||
|
|
||
| * A machine on which to install Halyard | ||
| * A [SQL Databaase](/docs/setup/install/storage/) | ||
| * MariaDB/MySQL are supported. This includes various cloud provided databases like AWS RDS & Google's |
There was a problem hiding this comment.
maybe to keep it simpler it should say
Supports some Cloud providers
I can help by adding a new page that details the cloud providers AWS, Azure, GCP details
| Debian 10 or higher), or it can be a Docker container. | ||
| Make sure it has at least 12GB of memory. | ||
| * An [external Redis server](/docs/setup/install/redis/) | ||
| * The default install will include a local redis. IT IS NOT recommended to use this but to externalize your redis to a more persistent solution. Redis data does need to be persisted in production environments. |
There was a problem hiding this comment.
if is using SQL, is Redis still needed for Prod?
There was a problem hiding this comment.
Yes - it's used for several things still including session handling.
| > Other installation targets may work but are not supported. For large scale production Kubernetes is recommended: | ||
| > * [Local development](https://www.spinnaker.io/setup/install/environment/#local-git) | ||
| > * [Debian local](https://www.spinnaker.io/setup/install/environment/#local-debian) | ||
| > * [Vagrant example (uses local debian)](hhttps://github.com/ashleykleynhans/vagrant-jenkins-spinnaker/) |
| without the need for helm or an operator or halyard CLI tooling. | ||
| - [OpsMx Operator](https://operatorhub.io/operator/spinnaker-operator) is an open source Helm chart for | ||
| installing Spinnaker. | ||
| - [OpsMx Helm Chart](https://github.com/kubernetes/charts/tree/master/stable/spinnaker) **As of Nov 13, 2020, |
There was a problem hiding this comment.
how about adding a list of references for helm charts
|
|
||
| Installing a complete Spinnaker involves these steps: | ||
| ## The process | ||
| Installing a complete Spinnaker involves these steps (documented using Halyard): | ||
| 1. [Install Halyard](/docs/setup/install/halyard/) |
There was a problem hiding this comment.
this looks like the guideline when installing with Halyard
| 1. [Choose a storage service](/docs/setup/install/storage/) | ||
| 1. [Add a kubernetes Provider](/docs/setup/install/providers/kubernetes-v2/) | ||
| 1. [Basic Settings](/docs/setup/install/install-config/) | ||
| 1. [Configure storage(SQL & Redis)](/docs/setup/install/storage/) | ||
| 1. [Deploy Spinnaker](/docs/setup/install/deploy/) | ||
| 1. [Back up your config](/docs/setup/install/backups/) | ||
| 1. [Configure everything else](/docs/setup/other_config/) (which includes a lot of |
There was a problem hiding this comment.
i can add some details later on here. Everything else sounds ambiguous
|
|
||
| Options for installing Spinnaker in Kubernetes: | ||
| - [Minnaker](https://github.com/armory/minnaker). THough this project is not maintained, it can provide basic guidance on setting up spinnaker on a simple VM. |
| without the need for helm or an operator or halyard CLI tooling. Caution: This uses things LIKE a mariadb driver which | ||
| is not currently available in the project by default. |
There was a problem hiding this comment.
| without the need for helm or an operator or halyard CLI tooling. Caution: This uses things LIKE a mariadb driver which | |
| is not currently available in the project by default. | |
| without the need for helm or an operator or halyard CLI tooling. |
The Kustomize installation seems to work fine with the OSS Spinnaker container images in my limited testing: creating apps, pipelines and running pipelines, etc.
| aliases: | ||
| - /setup/quickstart/ | ||
| --- | ||
|
|
||
| If you want to install Spinnaker on Lightweight Kubernetes (K3s) for proofs of concept, see the open source project [Minnaker](https://github.com/armory/minnaker). You can install Spinnaker in about 10 minutes in a local or cloud VM. | ||
| There are several simple options to trying spinnaker. Note that even testing spinnaker does require a fair bit of resources. Below references are examples only and are not official spinnaker projects but included for ease of use. | ||
|
|
There was a problem hiding this comment.
I understand the support factor and think the above wording is good.
The spinnaker-kustomize repo is the fastest way to get a Spinnaker up and running in my experience.
$ make create && make build && make apply
https://github.com/spinnaker/spinnaker-kustomize#quick-start
Explicitly calls out the need to use SQL. This is a DRAFT - welcome input and changes/thoughts.