Skip to content

Commit

Permalink
docs(installation): clarifications added on Halyard Versions (#220)
Browse files Browse the repository at this point in the history
* 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 <aimeeu.opensource@gmail.com>
  • Loading branch information
kinnonyee-armory and aimeeu authored Sep 25, 2020
1 parent 4aa5eb0 commit 6d16b4e
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 10 deletions.
5 changes: 4 additions & 1 deletion content/en/docs/installation/armory-halyard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -39,14 +41,15 @@ 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:

```
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

Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/installation/guide/install-on-aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<image_version>` in the commands below*
```bash
docker run --name armory-halyard -it --rm \
Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/installation/guide/install-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<image_version>` in the commands below*

```bash
docker run --name armory-halyard -it --rm \
Expand Down
6 changes: 4 additions & 2 deletions content/en/docs/installation/guide/install-on-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<image_version>` in the commands below*
```bash
docker run --name armory-halyard -it --rm \
Expand Down
8 changes: 5 additions & 3 deletions content/en/docs/installation/guide/install-on-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -718,17 +720,17 @@ 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:

```bash
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:

Expand Down
1 change: 1 addition & 0 deletions content/en/includes/halyard-note.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 6d16b4e

Please sign in to comment.