Skip to content
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.

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

Minor documentation typos #98

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions guides/first-pipeline-jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Then, we'll build out the process to do the following:
* Jenkins build a Docker image
* Jenkins push the Docker image to ECR (alternately, to Docker Hub)
* Jenkins send a webhook to Spinnaker to trigger a Spinnaker pipeline, with a Docker image artifact
* Spinnaker receive the webhook, pull a Kubernets manifest from GitHub, hydrate the Docker image, and deploy the manifest to a Kubernetes cluster
* Spinnaker receive the webhook, pull a Kubernetes manifest from GitHub, hydrate the Docker image, and deploy the manifest to a Kubernetes cluster

We assume the following in this document:
* You have the following set up and configured:
Expand Down Expand Up @@ -82,7 +82,7 @@ Then, using Halyard, add the credential to Spinnaker as "GitHub artifact Account

Assuming Jenkins is running in a different AWS account from your ECR repository, you'll need to set up cross-account access.

* Get the AWS account ID for the AWS account where Jenkins is running (you can use the command `aws sts get-caller-identity` to see what account you're accesssing from; for example, an ARN of `arn:aws:sts::222233334444:assumed-role/ec2-role/i-00001111222233334` means you're in `222233334444`)
* Get the AWS account ID for the AWS account where Jenkins is running (you can use the command `aws sts get-caller-identity` to see what account you're accessing from; for example, an ARN of `arn:aws:sts::222233334444:assumed-role/ec2-role/i-00001111222233334` means you're in `222233334444`)
* Log into to the AWS console account where your ECR repository exists, and go to Compute > ECR
* Click on your repository
* On the left side, click on "Permissions"
Expand Down
4 changes: 2 additions & 2 deletions guides/first-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ Spinnaker has a native capability to perform this latter option. This is what w

In Kubernetes, Deployments can be used to handle the rollouts of your application: if you have version A of your application, and want to update it to version B of your application, you update your Deployment specification and Kubernetes will handle creating / updating the ReplicaSets to handle the upgrade in a rolling fashion.

Spinnaker is able to directly use this mechanism, and when you use Spinnaker to create Deployments, your pods will follow whatever pattern Kuberntes uses to meet your Kubernetes Deployment pattern. Spinnaker also adds annotations to be able to roll back to previous iterations (we'll see this later on).
Spinnaker is able to directly use this mechanism, and when you use Spinnaker to create Deployments, your pods will follow whatever pattern Kubernetes uses to meet your Kubernetes Deployment pattern. Spinnaker also adds annotations to be able to roll back to previous iterations (we'll see this later on).

If we want more control of our application rollout - for example to do a Blue/Green deployment - then Spinnaker can also directly interact with Kubernetes ReplicaSets. Then, if we add the proper annotations to our ReplicaSets to indicate what Service they *should* be dynamically attached to / detached from, then Spinnaker will do the following:

Expand Down Expand Up @@ -796,7 +796,7 @@ Be aware of these things when setting up webhook triggers:
* You can have multiple webhook triggers for a given pipeline.
* You can inject additional metadata into the pipeline that isn't exposed through a parameter, through additional fields in the trigger. All fields in the triggering webhook will be available for usage in the pipeline through SpEL.

## Triggering a pipeline without a wehook trigger, with a webhook
## Triggering a pipeline without a webhook trigger, with a webhook

In addition to the above trigger, every time you click "Start Manual Execution" through the Spinnaker UI, your browser is making an API call, acting as you, to the Spinnaker (Gate) API. You can use the same API to trigger pipelines in an authenticated manner.

Expand Down
4 changes: 2 additions & 2 deletions guides/setup-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Open two terminals one will be for shell access into minnaker-vm the other will
./minnaker/scripts/utils/external_service_setup.sh orca echo
```

9. [host] Setup your host config files
9. [host] Setup your host config files
- Create/edit the file `~/.spinnaker/spinnaker-local.yml`, and paste the previously copied output.
```
services:
Expand Down Expand Up @@ -196,7 +196,7 @@ Open two terminals one will be for shell access into minnaker-vm the other will

14. Open your project

* If you don't have a project open, you'll see a "Welcome to IntellJ IDEA".
* If you don't have a project open, you'll see a "Welcome to IntelliJ IDEA".

1. Click "Open or Import"

Expand Down
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Minnaker performs the following actions when run on a single Linux instance:
* Installs and configures **[Spinnaker](https://github.com/spinnaker)** or **[Armory](https://armory.io)** using the **Spinnaker Operator**.
* Exposes Spinnaker using an Ingress. NOTE: If you're using an AWS EC2 instance, make sure you add port 443 to the security group.
* Minnaker uses local authentication. The username is `admin` and the password is randomly generated when you install Minnaker. Find more details about getting the password in [Accessing Spinnaker](#accessing-spinnaker).
* For the full list of customizations and configurations - please check out the [kustomization-minnaker.yml] (https://github.com/armory/spinnaker-kustomize-patches/blob/minnaker/recipes/kustomization-minnaker.yml) file.
* For the full list of customizations and configurations - please check out the [`kustomization-minnaker.yml`](https://github.com/armory/spinnaker-kustomize-patches/blob/minnaker/recipes/kustomization-minnaker.yml) file.

## Requirements

Expand All @@ -38,7 +38,7 @@ To use Minnaker, make sure your Linux instance meets the following requirements:

## Changelog

* 2/XX/2021 - Major update - install.sh has been replaced to use the spinnaker operator as the default installation method. Todo: Many of the convience scripts will also need to be updated to use the operator as well. If you would still like to use Halyard - please reference [Release 0.0.23](https://github.com/armory/minnaker/releases/tag/0.0.22)
* 2/XX/2021 - Major update - install.sh has been replaced to use the spinnaker operator as the default installation method. Todo: Many of the convenience scripts will also need to be updated to use the operator as well. If you would still like to use Halyard - please reference [Release 0.0.23](https://github.com/armory/minnaker/releases/tag/0.0.22)
* operator_install.sh replaces install.sh
* removing operator_install.sh
* ToDo: Clean up all other scripts to remove dependency on halyard.
Expand Down Expand Up @@ -66,9 +66,9 @@ To use Minnaker, make sure your Linux instance meets the following requirements:
* By default, the script installs Armory Spinnaker and uses your public IP address (determined by `curl`ing `ifconfig.co`) as the endpoint for Spinnaker.
* For bare metal or a local VM, specify the IP address for your server with `-P` flag. `-P` is the 'Public Endpoint' and must be an address or DNS name you will use to access Spinnaker (an IP address reachable by your end users).

```bash
./scripts/install.sh
```
```bash
./scripts/install.sh
```

For example, the following command installs OSS Spinnaker on a VM with the IP address of `192.168.10.1`:

Expand Down Expand Up @@ -119,7 +119,7 @@ To use Minnaker, make sure your Linux instance meets the following requirements:
1. SSH into the machine where you have installed Spinnaker
2. Modify the contents of `~/spinnaker/spinsvc/kustomization.yml` and the associated patch files.

** PRO TIP: Use [VS Code - Remote SSH extension](https://code.visualstudio.com/docs/remote/ssh) to interact with your minnaker instance, and manage and edit multiple files **
** PRO TIP: Use [VS Code - Remote SSH extension](https://code.visualstudio.com/docs/remote/ssh) to interact with your Minnaker instance, and manage and edit multiple files **

See [Armory's Spinnaker Operator] (https://docs.armory.io/docs/installation/operator/).

Expand All @@ -137,7 +137,7 @@ Alternatively, take a look at the available Minnaker [guides](/guides/).

To learn more about the Spinnaker Operator check out the docs here: https://docs.armory.io/docs/installation/operator/

Also check out the [`spinnaker-kustomize-patches`](https://github.com/armory/spinnaker-kustomize-patches#kustomize-patches-for-armory) repo
Also check out the [`spinnaker-kustomize-patches`](https://github.com/armory/spinnaker-kustomize-patches#kustomize-patches-for-armory) repo.

## Details

Expand Down Expand Up @@ -301,7 +301,7 @@ $ kubectl -n spinnaker logs -f spin-gate-75c99f6b9d-fcgth
```

## Uninstalling K3s
* This will kill your kubernetes cluster: `/usr/local/bin/k3s-killall.sh`
* This will kill your Kubernetes cluster: `/usr/local/bin/k3s-killall.sh`

## Uninstall Minnaker for OSX
* Delete the `spinnaker` and `spinnaker-operator` namespace.
Expand Down