From 6d16b4ea42d5ff968ee5411e396c0f7215e44f64 Mon Sep 17 00:00:00 2001 From: kinnonyee-armory <61215361+kinnonyee-armory@users.noreply.github.com> Date: Fri, 25 Sep 2020 12:04:46 -0400 Subject: [PATCH] docs(installation): clarifications added on Halyard Versions (#220) * docs(installation): clarifications added on Halyard Versions Added references to Armory's release versions, along with release notes, instead of the repo. Release notes will help people also determine what versions is needed Added some more clarification if installing OSS Halyard, about what line to replace in the code * change Halyard text to an included file Co-authored-by: Aimee Ukasick --- content/en/docs/installation/armory-halyard.md | 5 ++++- content/en/docs/installation/guide/install-on-aks.md | 6 ++++-- content/en/docs/installation/guide/install-on-aws.md | 6 ++++-- content/en/docs/installation/guide/install-on-gke.md | 6 ++++-- content/en/docs/installation/guide/install-on-k8s.md | 8 +++++--- content/en/includes/halyard-note.md | 1 + 6 files changed, 22 insertions(+), 10 deletions(-) create mode 100644 content/en/includes/halyard-note.md diff --git a/content/en/docs/installation/armory-halyard.md b/content/en/docs/installation/armory-halyard.md index 501800bf4f..2e22d6530e 100644 --- a/content/en/docs/installation/armory-halyard.md +++ b/content/en/docs/installation/armory-halyard.md @@ -7,6 +7,8 @@ description: > Armory-extended Halyard is a versatile command line interface (CLI) to configure and deploy Spinnaker. It is made of a CLI that connects to a daemon. +{{< include "halyard-note.md" >}} + ## Running in Docker Running Armory-extended Halyard in Docker is convenient and portable. The daemon will need access to files and environment variables, such as: @@ -39,6 +41,7 @@ the `.kube` directory you map below. If you've named your config something else, you'll need to rename or symlink the file accordingly. ### Running Halyard Commands + Once Armory-extended Halyard is running, you can interact with it by opening a separate Terminal and running: @@ -46,7 +49,7 @@ Terminal and running: docker exec -it armory-halyard bash ``` -From there, you can issue all your [halyard commands](https://www.spinnaker.io/reference/halyard/). +From there, you can issue all your [Halyard commands](https://www.spinnaker.io/reference/halyard/). ## Run in Kubernetes diff --git a/content/en/docs/installation/guide/install-on-aks.md b/content/en/docs/installation/guide/install-on-aks.md index 1003d69c8d..4694fab3c9 100644 --- a/content/en/docs/installation/guide/install-on-aks.md +++ b/content/en/docs/installation/guide/install-on-aks.md @@ -236,9 +236,11 @@ cp kubeconfig-spinnaker-system-sa ${WORKING_DIRECTORY}/.secret ## Start the Halyard container -On the `Halyard machine`, start the Halyard container (see the `armory/halyard-armory` [tag list](https://hub.docker.com/r/armory/halyard-armory/tags)) for the latest Armory-extended Halyard Docker image tag. +{{< include "halyard-note.md" >}} -*If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker image.* +On the `Halyard machine`, start the Halyard container. + +*If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker Halyard image reference in substitution of `armory/halyard-armory:` in the commands below* ```bash docker run --name armory-halyard -it --rm \ diff --git a/content/en/docs/installation/guide/install-on-aws.md b/content/en/docs/installation/guide/install-on-aws.md index c17c71fea2..4cedb0a723 100644 --- a/content/en/docs/installation/guide/install-on-aws.md +++ b/content/en/docs/installation/guide/install-on-aws.md @@ -314,9 +314,11 @@ cp kubeconfig-spinnaker-system-sa ${WORKING_DIRECTORY}/.secret ## Start the Halyard container -On the `docker machine`, start the Halyard container (see the `armory/halyard-armory` [tag list](https://hub.docker.com/r/armory/halyard-armory/tags)) for the latest Armory-extended Halyard Docker image tag. +{{< include "halyard-note.md" >}} -_If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker image_ +On the `Halyard machine`, start the Halyard container . + +*If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker Halyard image reference in substitution of `armory/halyard-armory:` in the commands below* ```bash docker run --name armory-halyard -it --rm \ diff --git a/content/en/docs/installation/guide/install-on-gke.md b/content/en/docs/installation/guide/install-on-gke.md index 098ae23b02..1e8ab7754e 100644 --- a/content/en/docs/installation/guide/install-on-gke.md +++ b/content/en/docs/installation/guide/install-on-gke.md @@ -227,9 +227,11 @@ cp spinnaker-gcs-account.json ${WORKING_DIRECTORY}/.secret ## Start the Halyard container -On the `docker machine`, start the Halyard container (see the `armory/halyard-armory` [tag list](https://hub.docker.com/r/armory/halyard-armory/tags)) for the latest Armory-extended Halyard Docker image tag. +{{< include "halyard-note.md" >}} -*If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker image* +On the `Halyard machine`, start the Halyard container. + +*If you want to install OSS Spinnaker instead, use `gcr.io/spinnaker-marketplace/halyard:stable` for the Docker Halyard image reference in substitution of `armory/halyard-armory:` in the commands below* ```bash docker run --name armory-halyard -it --rm \ diff --git a/content/en/docs/installation/guide/install-on-k8s.md b/content/en/docs/installation/guide/install-on-k8s.md index 19f695f003..eba38b5d77 100644 --- a/content/en/docs/installation/guide/install-on-k8s.md +++ b/content/en/docs/installation/guide/install-on-k8s.md @@ -47,6 +47,8 @@ The _Armory Operator_ is the newest installation and configuration method for Ar Halyard is the former installation method for Armory. It has been around the longest and is the first one supporting new Armory features. Operator uses a customized version of Halyard that is constantly updated to incorporate changes from base Halyard. +{{< include "halyard-note.md" >}} + *Prerequisites* * Your Kubernetes cluster has storage set up so that PersistentVolumeClaims properly allocates PersistentVolumes. @@ -718,7 +720,7 @@ EOF ### Select the Armory version to install -Before you use Halyard to install Armory, specify the version of Armory you want to use. +Before you use Armory-extended Halyard to install Armory, specify the version of Armory you want to use. Make sure the version of Armory you want to install is compatible with the version of Armory-extended Halyard you are using. You can get a list of available versions of Armory with this command: @@ -726,9 +728,9 @@ You can get a list of available versions of Armory with this command: hal version list ``` -* If you are installing Armory using Armory's Halyard, the command returns a version that starts with `2.x.x` +* If you are installing Armory using Armory-extended Halyard, the command returns a version that starts with `2.x.x` -* If you are installing OSS Armory and using `gcr.io/spinnaker-marketplace/halyard:stable`, the command returns a version that starts with `1.x.x` +* If you are installing open source Spinnaker and using open source Halyard (installed from `gcr.io/spinnaker-marketplace/halyard:stable`), the command returns a version that starts with `1.x.x` Select the version with the following: diff --git a/content/en/includes/halyard-note.md b/content/en/includes/halyard-note.md new file mode 100644 index 0000000000..fb9225be17 --- /dev/null +++ b/content/en/includes/halyard-note.md @@ -0,0 +1 @@ +>Visit the [Armory-extended Halyard Release Notes page]({{< ref "rn-armory-halyard" >}}) for a list of available Armory-extended Halyard versions and their release notes. You can view version differences as well as which versions are compatible with which Armory releases.