Skip to content

Commit

Permalink
docs(saas): reorganize and rewrite content in preparation for saas (#211
Browse files Browse the repository at this point in the history
)

* reorg

* more

* docs(pipelines): remove unused demo pipelines feature (#213)

(cherry picked from commit 999909b)

* see if older link checker version fails

* see if older link checker version fails

* remove :

* i give up. the imgs arent actually broken

* more moving

* break the json

* more moving

* more moving

* more moving

* drop version back down to 1.05 on link checker

* fix broken link

* finish the moving

* delete weight from frontmatter

* fix broken links

* Update redirects in netlify.toml

* Revert redirects in netlify.toml

Redirects to new section but not to new page name in cases
where page name has been changed

* add /docs/ to new page redirects

* add missing : to mlc_config.json

* Fix broken URLs; update linkcheck to 1.0.7

Co-authored-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
  • Loading branch information
317brian and aimeeu authored Sep 22, 2020
1 parent 6aa9d45 commit 7e4318d
Show file tree
Hide file tree
Showing 116 changed files with 693 additions and 1,125 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/mlc_config.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"ignorePatterns" [
"ignorePatterns": [
{
"pattern": "/^images/(.*)"
"pattern": "/^images/(*.*)"
},
{
"pattern": "/^Images/(.*)"
"pattern": "/^Images/(*.*)"
},
{
"pattern": "^http://localhost:9000"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-link-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@master
with:
fetch-depth: 1
- uses: gaurav-nelson/github-action-markdown-link-check@1.0.6
- uses: gaurav-nelson/github-action-markdown-link-check@1.0.7
with:
use-quiet-mode: 'yes' # Specify yes to only show errors in output.#
use-verbose-mode: 'yes' # Specify yes to show detailed HTTP status for checked links.#
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@ title: "Overview"
linkTitle: "Overview"
weight: 1
description: >
Overview of Spinnaker, Nomenclature, Applications, Pipelines, Load Balancers, Glossary
Overview of Armory, Spinnaker, and related technology
---

5 changes: 2 additions & 3 deletions content/en/docs/Overview/architecture.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "Spinnaker Architecture"
title: "Armory Architecture"
summary: "Learn about the services that work together in Spinnaker."
weight: 2
linkTitle: "Architecture"
aliases:
- /spinnaker-install-admin-guides/architecture/
---
Expand All @@ -11,7 +10,7 @@ Spinnaker is composed of several microservices for resiliency
and follows the single-responsibility principle. It allows for faster iteration on each
individual component and a more pluggable architecture for custom components.

![Architecture Diagram](/images/install_admin_guides_SpinnakerArchitecture.png)
![Architecture Diagram](/images/overview/SpinnakerArchitecture.png)

## Spinnaker microservices

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/Overview/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Spinnaker solves these problems by enabling safer and faster deployments with th

A typical work flow with Spinnaker starts with baking a Linux-based machine image. This image along with your launch configurations define an immutable infrastructure that you can use to deploy to your cloud provider with Spinnaker. After the deployment, run your tests, which can be integrated with Spinnaker and automatically triggered. Based on your deployment strategy and any criteria you set, go live with the build.

## What Armory is
## Armory

Armory's platform includes an enterprise-grade distribution of Spinnaker that forms the core of Armory's Platform. It is preconfigured and runs in your Kubernetes cluster. The platform is an extension of open source Spinnaker and includes all those benefits as well as the following:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
---
layout: post
title: Spinnaker Secrets Overview
weight: 1
title: "Working with Secrets"
linkTitle: "Working with Secrets"
description: >
Armory supports several secret stores. Use them to keep your secrets secure and not commit plain text secrets to your configs.
aliases:
- /spinnaker-install-admin-guides/secrets/
- /docs/spinnaker-install-admin-guides/secrets/
- /docs/spinnaker/halyard_secrets/
- /docs/spinnaker/halyard-secrets/
- /docs/spinnaker-install-admin-guides/secrets/secrets/
---

## Overview
Expand Down Expand Up @@ -86,10 +90,4 @@ You can also provide secret references directly in `SpinnakerService` manifest u

### Supported secret engines

* [Encrypted S3 buckets]({{< ref "secrets-s3" >}}) (Open Source Spinnaker)
* [Google Storage (GCS)]({{< ref "secrets-gcs" >}}) (Open Source Spinnaker)
* [Kubernetes Secrets]({{< ref "secrets-kubernetes" >}}) (Open Source Spinnaker, only available if using the Operator)
* [AWS Secrets Manager]({{< ref "secrets-aws-sm">}})(Open Source Spinnaker)
* [Hashicorp Vault]({{< ref "secrets-vault" >}}) (Armory)

Is there a secret engine you'd like us to support? Submit a feature request [here](http://go.armory.io/support)!
Is there a secret engine you'd like us to support? Submit a feature request [here](mailto:hello@armory.io)!
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Secrets with AWS Secrets Manager
aliases:
- /docs/spinnaker-install-admin-guides/secrets/secrets-aws-sm/
---

You can configure AWS Secrets Manager as a secrets engine for Spinnaker. For information about how to set up AWS Secrets Manager, see the [AWS documentation](https://docs.aws.amazon.com/secretsmanager/index.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Secrets with GCS
weight: 50
aliases:
- /spinnaker-install-admin-guides/secrets-gcs/
- /docs/spinnaker-install-admin-guides/secrets-gcs/
- /docs/spinnaker-install-admin-guides/secrets/secrets-gcs/
---

This document describes how to set up Spinnaker secrets in an encrypted GCS bucket. This example uses a bucket (`mybucket`) to store GitHub credentials and a kubeconfig file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ layout: post
title: Secrets in Kubernetes
weight: 50
aliases:
- /spinnaker-install-admin-guides/secrets-kubernetes/
- /docs/spinnaker-install-admin-guides/secrets-kubernetes/
- /docs/spinnaker-install-admin-guides/secrets/secrets-kubernetes/
---

>Note: Storing Spinnaker secrets in a Kubernetes secret is only supported if you're using the Operator to deploy and manage Spinnaker.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Secrets with S3
weight: 50
aliases:
- /spinnaker-install-admin-guides/secrets-s3/
- /docs/spinnaker-install-admin-guides/secrets-s3/
- /docs/spinnaker-install-admin-guides/secrets/secrets-s3/
---

This document describes how to set up Spinnaker secrets in an encrypted S3 bucket. This example uses a bucket (`mybucket`) in the `us-west-2` region to store GitHub credentials and a kubeconfig file. You reference the bucket by its URL `mybucket.us-west-2.amazonaws.com`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Secrets with Vault
weight: 10
aliases:
- /spinnaker-install-admin-guides/secrets-vault/
- /docs/spinnaker-install-admin-guides/secrets-vault/
- /docs/spinnaker-install-admin-guides/secrets/secrets-vault/
---

This document describes how to set up Spinnaker secrets in Hashicorp's Vault. In this example, we'll be using the default KV secret engine called `secret` and will be storing GitHub credentials, a kubeconfig file and a Java keystore for SAML SSO.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ layout: post
title: Configuring Vault for Kubernetes Auth
weight: 10
aliases:
- /spinnaker-install-admin-guides/vault-configuration/
- /docs/spinnaker-install-admin-guides/vault-configuration/
- /docs/spinnaker-install-admin-guides/secrets/vault-configuration/
---

## Overview
Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/armory-admin/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Armory Admin"
description: Administer an Armory deployment that is installed in your environment.
weight: 3
---
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "AWS: Deploying to AWS from Spinnaker (using IAM credentials)"
weight: 33
aliases:
- /spinnaker_install_admin_guides/add-aws-account/
- /spinnaker_install_admin_guides/add_aws_account/
- /spinnaker-install-admin-guides/add_aws_account/
- /spinnaker-install-admin-guides/add-aws-account/
---

Once you have (OSS or Armory) Spinnaker up and running in Kubernetes, start adding deployment targets.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Exposing the API Endpoint
weight: 47
title: Exposing the Spinnaker API Endpoint
linkTitle: Exposing the API
aliases:
- /spinnaker_install_admin_guides/api-endpoint/
- /spinnaker_install_admin_guides/api_endpoint/
- /spinnaker-install-admin-guides/api_endpoint/
- /docs/spinnaker-install-admin-guides/api-endpoint/
---
## Overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Armory-extended Halyard Reference
linkTitle: Halyard Reference
weight: 4
description: >
Command reference with examples and Operator equivalents
aliases:
- /docs/spinnaker/armory_halyard/
- /docs/installation/armory-halyard-reference/
---

## hal
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Docker Registries
weight: 51
title: Connecting Docker Registries
aliases:
- /spinnaker_install_admin_guides/docker/
- /docs/spinnaker-install-admin-guides/docker/
---

## Overview
Expand Down Expand Up @@ -104,4 +104,4 @@ repositories explicitly, like above. Some do not (such as the Google
Container Registry). Further details can be found [here](https://www.spinnaker.io/setup/install/providers/docker-registry/).

Amazon's ECR requires additional configuration to work properly with Spinnaker.
[We've documented this separately]({{< ref "ecr-registry" >}}).
[We've documented this separately]({{< ref "artifacts-ecr-connect" >}}).
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
title: "AWS: Configuring AWS ECR as a Registry"
weight: 52
title: "Connecting to AWS ECR as a Registry"
linkTitle: "Connecting to AWS ECR"
aliases:
- /admin-guides/ecr-registry/
- /admin-guides/ecr_registry/
- /admin_guides/ecr-registry/
- /admin_guides/ecr_registry/
- /spinnaker_install_admin_guides/ecr_registry/
- /spinnaker_install_admin_guides/ecr-registry/
- /spinnaker-install-admin-guides/ecr_registry/
- /docs/spinnaker-install-admin-guides/ecr-registry/
---

This document reviews configuring ECR as a registry for a Spinnaker installation.
Expand Down Expand Up @@ -93,4 +90,4 @@ hal deploy apply --service-names clouddriver

Success! Now you will be able to use ECR as a docker registry in the configuration stage.

![](/images/Image-2018-12-18-at-2.02.02-PM.png)
![](/images/armory-admin/artifacts/ecr-test.png)
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
---
title: Configure Spinnaker to use Github as an Artifact Source
linkTitle: Github as an Artifact Source
weight: 49
title: Connecting Spinnaker to GitHub as an Artifact Source
linkTitle: Connecting to GitHub
aliases:
- /spinnaker_install_admin_guides/github/
- /docs/spinnaker-install-admin-guides/github
---

## Configuring a Github Trigger
## Configuring a GitHub Trigger

Spinnaker pipelines can be configured to trigger when a change is committed
to a Github repository. This doesn't require any configuration of Spinnaker
other than [adding a Github trigger](/docs/spinnaker-user-guides/github/) but does
require administration of the Github repositories to configure the webhook.
to a GitHub repository. This doesn't require any configuration of Spinnaker
other than [adding a GitHub trigger]({{< ref "artifacts-github-use" >}}) but does
require administration of the GitHub repositories to configure the webhook.

The open source documentation
[has concise instructions for configuring Github webhooks.](https://www.spinnaker.io/setup/triggers/github/)
[has concise instructions for configuring GitHub webhooks.](https://www.spinnaker.io/setup/triggers/github/)

## Configuring Github as an Artifact Source
## Configuring GitHub as an Artifact Source

If you actually want to use a file from the Github commit in your pipeline,
you'll need to configure Github as an artifact source.
If you actually want to use a file from the GitHub commit in your pipeline,
you'll need to configure GitHub as an artifact source.

This is just a quick walkthrough of how to configure your Spinnaker to access a
Github repo as a source of artifacts. Many of the commands below have
GitHub repo as a source of artifacts. Many of the commands below have
additional options that may be useful (or possibly required). If you need
more detailed help, take a look at the
[Halyard command reference](https://www.spinnaker.io/reference/halyard/commands/#hal-config-artifact-github) if you're deploying Spinnaker with Halyard.

### Enable Github Artifacts
### Enable GitHub Artifacts

If you haven't done this yet (for example, if you've just installed Armory
Spinnaker fresh), you'll need to enable Github as an artifact source:
Spinnaker fresh), you'll need to enable GitHub as an artifact source:

**Operator**

Expand Down Expand Up @@ -58,18 +58,18 @@ hal config features edit --artifacts true
hal config artifact github enable
```

### Add a Github Credential
### Add a GitHub Credential

To access private Github repositories, you'll need a Github "Personal Access
Token". This can be generated by going to the "Settings" page in Github, then
To access private GitHub repositories, you'll need a GitHub "Personal Access
Token". This can be generated by going to the "Settings" page in GitHub, then
clicking on "Developer Settings" and then "Personal Access Token". The token
will need the `repo` scope.

Once you have a token, you should provide that token for Spinnaker's Igor service
as a credential to use to access Github. This can be done with a command like
as a credential to use to access GitHub. This can be done with a command like
this:

*Replace the account name `github_user` with the string you want to use to identify this Github credential.*
*Replace the account name `github_user` with the string you want to use to identify this GitHub credential.*

**Operator**

Expand All @@ -90,14 +90,14 @@ spec:
enabled: true
accounts:
- name: github_user
token: abc # Github's personal access token. This fields supports `encrypted` references to secrets.
token: abc # GitHub's personal access token. This fields supports `encrypted` references to secrets.
# username: abc # GitHub username
# password: abc # GitHub password. This fields supports `encryptedreferences` to secrets.
# usernamePasswordFile: creds.txt # File containing "username:password" to use for GitHub authentication. This fields supports `encryptedFilereferences` to secrets.
# tokenFile: token.txt # File containing a GitHub authentication token. This fields supports `encryptedFile` references to secrets.
```

If you have a Github personal access token, you only need that to authenticate against Github, but there are other authentication options like username/password, or specifying credentials in a `file` entry.
If you have a GitHub personal access token, you only need that to authenticate against GitHub, but there are other authentication options like username/password, or specifying credentials in a `file` entry.

Don't forget to apply your changes:

Expand All @@ -117,34 +117,14 @@ Detailed information on all command line options can be found [here](https://www

Don't forget to run `hal deploy apply` to apply your changes.

## Using the Github Credential
## Using the GitHub Credential

You may note that the above Github "account" doesn't actually have a endpoint for
your Github; this account is basically just the credential used by Spinnaker
artifacts to access Github. The actual Github API endpoint is specified in the
You may note that the above GitHub "account" doesn't actually have a endpoint for
your GitHub; this account is basically just the credential used by Spinnaker
artifacts to access GitHub. The actual GitHub API endpoint is specified in the
artifact reference. There are a couple ways to use this credential, one example
of which is detailed here:

### Pulling a Kubernetes Manifest from Github

1. Under "Expected Artifacts" in your pipeline, create an artifact of type "Github".

1. Specify the "file path" as the path within the repository to your file. For example, if your manifest is at `demo/manifests/deployment.yml` in the Github repository `orgname/reponame` , specify `demo/manifests/deployment.yml`.

1. Check the "Use Default Artifact" checkbox.

1. In the "Content URL", provide the full path to the *API URI* for your manifest. Here are some examples of this:

* If you're using SaaS Github (www.github.com), the URI is generally formatted like this: `https://api.github.com/repos/<ORG>/<REPO>/contents/<PATH-TO-FILE>`.
* For example: `https://api.github.com/repos/armory/demo/contents/manifests/deployment.yml`

* If you have an on-prem Github Enterprise, then the URI may be formatted like this: `https://<GITHUB_URL>/api/v3/repos/<ORG>/<REPO>/contents/<PATH-TO-FILE>`.
* For example: `http://github.customername.com/api/v3/repos/armory/spinnaker-pipelines/contents/manifests/deployment.yml`

1. Create a "Deploy (Manifest)" stage. Rather than specifying the manifest directly in the UI, under the "Manifest Source" specify "Artifact", and in the "Expected Artifact" field, select the artifact you created above.

1. If you have multiple Github Accounts (credentials) added to your Spinnaker cluster, there should be a dropdown to select which one to use.

## Troubleshooting Credentials and URIs

To verify that your token and URI are correct, you can run a `curl` command to
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
title: "AWS: Configure S3 Artifacts"
weight: 61
title: "Configuring S3 Artifacts"
aliases:
- /spinnaker_install_admin_guides/s3/
- /docs/spinnaker-install-admin-guides/s3/
description: To use a file stored in S3 in your pipeline, configure Spinnaker to use S3 as an artifact source.
---

## Overview

If you want to use a file from S3 in your pipeline,
you'll need to configure S3 as an artifact source. This is how you would,
for example, reference a Helm chart tarball for later use during
The example on this page describes how to reference a Helm chart tarball for later use during
deployment.

This is just a quick walkthrough of how to configure your Spinnaker to access
Expand Down
Loading

0 comments on commit 7e4318d

Please sign in to comment.