Skip to content

Commit

Permalink
docs(migration): fix imgs and links
Browse files Browse the repository at this point in the history
  • Loading branch information
317brian committed May 7, 2021
1 parent 451e53e commit 9a18ce6
Show file tree
Hide file tree
Showing 90 changed files with 150 additions and 219 deletions.
6 changes: 0 additions & 6 deletions config.toml
Expand Up @@ -227,13 +227,7 @@ enable = false
url = "/docs/"

# Add your release versions here
[[params.versions]]
version = "v1.19"
url = "/docs/"

[[params.versions]]
version = "v1.20"
url = "/docs/v1.20/"

# baseURL = "/"
# languageCode = "en-us"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/concepts/providers/_index.md
Expand Up @@ -45,7 +45,7 @@ These are the cloud providers currently supported by Spinnaker:
* <a href="https://kubernetes.io/" target="_blank">Kubernetes</a>
* <a href="https://cloud.oracle.com/home" target="_blank">Oracle</a>

Setup instructions for providers are [here](/docs/setup/providers/)
Setup instructions for providers are [here](/docs/setup/install/providers/)

If you see a provider missing from this list that you feel Spinnaker should
support, we gladly welcome your contributions. Please reach out to us on
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/spin/_index.md
Expand Up @@ -6,5 +6,5 @@ description: >
You can edit pipelines, applications, and configs using the Spinnaker Command Line Interface (`spin` CLI).
---

Before you begin, see [Install and Configure Spin CLI](/docs/spin/other_config/spin).
Before you begin, see [Install and Configure Spin CLI](/docs/setup/other_config/spin/).

2 changes: 1 addition & 1 deletion content/en/docs/guides/spin/app/index.md
Expand Up @@ -3,7 +3,7 @@ title: "Manage Applications"
linkTitle: "Manage Apps"
weight: 2
description: >
Once you have `spin` [installed and configured](/docs/spin/other_config/spin), you can use it to manage your Spinnaker application's lifecycle.
Once you have `spin` installed and configured, you can use it to manage your Spinnaker application's lifecycle.
---


Expand Down
Expand Up @@ -30,7 +30,7 @@ gcloud services enable compute.googleapis.com

We're going to trigger our Spinnaker pipelines using Github webhooks. In order to do so,
we will have to expose Spinnaker's API gateway to external traffic.
If you are going to use this installation beyond this codelab, you should follow the [guides](/docs/setup/security) for securing Spinnaker.
If you are going to use this installation beyond this codelab, you should follow the [guides](/docs/setup/other_config/security/) for securing Spinnaker.

Create a new firewall rule for your GCP project.
Github sends webhooks from IPs in the [CIDR ranges](https://help.github.com/articles/github-s-ip-addresses/#service-hook-ip-addresses) queried below.
Expand Down
Expand Up @@ -11,7 +11,8 @@ In this codelab, you will deploy an artifact to Cloud Foundry via a Spinnaker pi

This codelab assumes you have the following:

* Artifact support [enabled](/docs/reference/artifacts-with-artifactsrewrite//#enabling-artifact-support).
* Artifact support [enabled](/docs/reference/artifacts/#enabling-artifact-support).
*
* An Artifactory repository configured to accept a Maven artifact&mdash;the JAR for your application
* A GitHub repository containing a manifest with which to deploy your application

Expand Down
Expand Up @@ -55,7 +55,7 @@ If you've deployed your Spinnaker instance with Halyard, configuring Spinnaker r

#### Enable Docker

[Configure a docker registry with halyard](/docs/setup/providers/docker-registry/)
[Configure a docker registry with halyard](/docs/setup/install/providers/docker-registry/)

#### Set up the DC/OS provider

Expand Down
Expand Up @@ -124,7 +124,7 @@ will allow us to fetch the manifests later.

### Configure Docker Registry account

Make sure to [add a Docker Registry provider account](/setup/install/providers/docker-registry).
Make sure to [add a Docker Registry provider account](/docs/setup/install/providers/docker-registry).
This will allow us to configure a Spinnaker pipeline to trigger on a Docker
image update.

Expand Down Expand Up @@ -216,9 +216,9 @@ kubectl describe node $NODE_NAME
For the purposes of this codelab, we'll be sending external webhooks to
`$NODE_PORT` on that node. In order for these webhooks to work, for this codelab
only, open your firewall on that node to all addresses for TCP connections on
`$NODE_PORT`. If you were running Spinnaker in production with [authentication](/setup/security),
`$NODE_PORT`. If you were running Spinnaker in production with [authentication](/docs/setup/other_config/security),
only webhooks would be allowed, which you can reject by header or payload. See
[the webhook guide for more details](/guides/user/triggers/webhooks).
[the webhook guide for more details](/docs/guides/user/pipeline/triggers/).

### Allow Docker to post build events

Expand Down Expand Up @@ -520,7 +520,7 @@ At this point there are few things you can play with:
* Roll back a "broken" change either in prod or staging using the "Undo
Rollout" stage.

* Insert [pipeline expressions](/docs/v1/guides/user/pipeline-expressions) into
* Insert [pipeline expressions](/docs/guides/user/pipeline/expressions) into
your manifest files.

## 10. Teardown
Expand Down
Expand Up @@ -119,7 +119,7 @@ Create a new pipeline by navigating to the PIPELINES tab and clicking the *New*

### Set up Deploy stage

There are multiple ways to deploy Kubernetes manifests using the Kubernetes provider. More details can be found in this [Deploying Kubernetes Manifests](/docs/v1/guides/user/kubernetes-v2/deploy-manifest/) guide.
There are multiple ways to deploy Kubernetes manifests using the Kubernetes provider. More details can be found in this [Deploying Kubernetes Manifests](/docs/guides/user/kubernetes-v2/deploy-manifest/) guide.

It is preferred to use artifacts as manifests. However, in this tutorial, the manifest is supplied statically to a pipeline as text for simplicity.

Expand Down
Expand Up @@ -88,7 +88,7 @@ We'll need this service account later, so keep these environment variables handy

First, configure your GCS artifact provider.

1. Enable [artifact support](/docs/reference/artifacts-with-artifactsrewrite//#enabling-artifact-support).
1. Enable [artifact support](/docs/reference/artifacts/#enabling-artifact-support).

2. Enable the GCS artifact provider:
`hal config artifact gcs enable`
Expand Down
15 changes: 7 additions & 8 deletions content/en/docs/guides/user/applications/configure.md
Expand Up @@ -7,16 +7,15 @@ description: >
---


Once you've [created an application](/docs/v1/guides/user/applications/create/), you can
Once you've [created an application](/docs/guides/user/applications/create/), you can
finish configuring it before adding infrastructure and pipelines.

## Start configuring

1. From within the application, click **CONFIG** at the top right of the
Spinnaker screen.

The application attributes you [defined when you created the
app](/docs/v1/guides/user/applications/create/) are shown at the top.
The application attributes you [defined when you created the app](/docs/guides/user/applications/create/) are shown at the top.

> **Note** Spinnaker can infer applications based on existing infrastructure.
> In these cases, there are no application attributes. For applications that
Expand Down Expand Up @@ -53,7 +52,7 @@ activity. These notifications are optional.
"Congratulations, your pipeline has finished!" Custom notification text is
optional.

![](/docs/v1/guides/user/applications/event_notification_prefs.png)
![](/docs/guides/user/applications/event_notification_prefs.png)

1. Click Update

Expand Down Expand Up @@ -82,7 +81,7 @@ to information related to the instance, like logs, health, and so on.

> **Note**: Custom instance links don't currently work for Kubernetes resources.
![](/docs/v1/guides/user/applications/instance_with_links.png)
![](/docs/guides/user/applications/instance_with_links.png)

These links are resolved using the public IP address of the instance, if
available, or the private IP otherwise. The default port is 80; if you want to
Expand All @@ -95,12 +94,12 @@ use a different port, begin the path with `:`.
1. In the **Links** fields, type the text that you want to display, and the path
to the link target.

You can reference [these specific instance attributes](/docs/v1/guides/user/instance-links/#available-template-fields)
You can reference [these specific instance attributes](/docs/guides/user/instance-links/#available-template-fields)
by wrapping them in curly braces. For example, to include the region where
the instance lives, for a GCE or AWS instance, use `{region}`. These are for
the path only, not the link display text.

![](/docs/v1/guides/user/applications/app_config_add_link.png)
![](/docs/guides/user/applications/app_config_add_link.png)

1. Click **Add Link** for each additional link you want displayed in this
section.
Expand All @@ -114,7 +113,7 @@ section.
1. Click **Save Changes** when you're finished.

Note that you can set default links across all applications, as described
[here](/docs/v1/guides/user/instance-links/#default-links).
[here](/docs/guides/user/instance-links/#default-links).


## Refresh caches
Expand Down
9 changes: 4 additions & 5 deletions content/en/docs/guides/user/applications/create.md
Expand Up @@ -23,9 +23,9 @@ applications available, the first thing you're going to do is create one.

1. Click **Actions**, then **Create Application**.

![](/docs/v1/guides/user/applications/create_application.png)
![](/docs/guides/user/applications/create_application.png)

1. Provide the application attributes in the **New Application** dialog.
2. Provide the application attributes in the **New Application** dialog.

| Field | Required | Description |
| --- | --- | --- |
Expand All @@ -38,11 +38,10 @@ applications available, the first thing you're going to do is create one.
| Instance port | No | This field is used to generate links from Spinnaker instance details to a running instance. The instance port can be used or overridden for specific links configured for your application (via the Config screen). |
| Enable restarting running pipelines | Bool, default=no | If enabled, users can restart pipeline stages while a pipeline is still running. This behavior is not recommended. |

1. Click **Create**.
3. Click **Create**.

## Next steps

You now have an application in which to start adding infrastructure and creating
pipelines. These application attributes are the minimum configuration, but you
will probably want to [finish configuring the
application](/docs/v1/guides/user/applications/configure/).
will probably want to [finish configuring the application](/docs/guides/user/applications/configure/).
2 changes: 1 addition & 1 deletion content/en/docs/guides/user/applications/delete.md
Expand Up @@ -16,4 +16,4 @@ first.
1. Scroll to the bottom of the application configuration screen, and click
**Delete Application**.

![](/docs/v1/guides/user/applications/delete_application.png)
![](/docs/guides/user/applications/delete_application.png)
Expand Up @@ -106,7 +106,7 @@ analysis](#run-the-canary-for-enough-time) you have to wait a long time
for the analysis to finish before you can refine it.

Fortunately, a Canary Analysis stage can be configured to use a [retrospective
analysis](/docs/v1/guides/user/canary/stage/#real-time-versus-retrospective-analysis)
analysis](/docs/guides/user/canary/stage/#real-time-versus-retrospective-analysis)
instead of a real-time analysis. This analysis is based on past monitoring data,
without having to wait for the data points to be generated. With this mode, you
can iterate more quickly on the development of the canary configuration.
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/user/canary/canary-overview.md
Expand Up @@ -41,7 +41,7 @@ installation](/docs/setup/other_config/canary/).
## How to make Canary work in Spinnaker&mdash;the high-level process

1. In Spinnaker, [create one or more canary
configurations](/docs/v1/guides/user/canary/config/).
configurations](/docs/guides/user/canary/config/).

The configuration provides the set of metrics for use in all pipeline
canary stages that reference it, plus default scoring thresholds and
Expand All @@ -57,7 +57,7 @@ configurations](/docs/v1/guides/user/canary/config/).
your metric store.

1. In any deployment pipeline that will use canary, [add one or more canary
stages](/docs/v1/guides/user/canary/stage/).
stages](/docs/guides/user/canary/stage/).

The canary stage includes information that scopes the templated query (canary
config) to a specified set of resources and time boundaries.
Expand Down
19 changes: 8 additions & 11 deletions content/en/docs/guides/user/canary/config/canary-config.md
Expand Up @@ -109,8 +109,7 @@ compared to the baseline.

Or select __either__, in which case it fails on deviation in either direction.

1. Optionally, choose a [filter
template](/docs/v1/guides/user/canary/config/filter_templates/).
1. Optionally, choose a [filter template](/docs/guides/user/canary/config/filter-templates/).

This is only available if your Spinnaker is
[configured for it](/docs/reference/halyard/commands/#hal-config-canary-edit).
Expand All @@ -122,7 +121,7 @@ template](/docs/v1/guides/user/canary/config/filter_templates/).
resource.labels.zone = starts_with("${zone}")
```

1. Identify the specific metric you're including in the analysis configuration:
2. Identify the specific metric you're including in the analysis configuration:

* In the __Metric Type__ field type at least 3 characters to populate the
field with available metrics.
Expand All @@ -132,7 +131,7 @@ template](/docs/v1/guides/user/canary/config/filter_templates/).

![List of available metrics](/docs/guides/user/canary/config/metric_type_list_cpu.png)

1. Optionally, if your telemetry provider supports aggregation of results, click
3. Optionally, if your telemetry provider supports aggregation of results, click
__Group by__ and enter the metric metadata attribute by which to group and
aggregate the data.

Expand All @@ -145,7 +144,7 @@ aggregate the data.
> __Metric groups versus grouping metrics__
>
> When you create a canary configuration, you [create metric
> groups](/docs/v1/guides/user/canary/config/#create-metric-groups-and-add-metrics),
> groups](/docs/guides/user/canary/config/#create-metric-groups-and-add-metrics),
> and scoring thresholds and weights are applied to groups (rather than to
> specific metrics). But the grouping described in this step is for
aggregating metrics before they're returned to Kayenta.
Expand All @@ -157,25 +156,23 @@ aggregate the data.

### Add filter templates

If your telemetry provider is Stackdriver or Prometheus, you can add [filter
templates](/docs/v1/guides/user/canary/config/filter_templates/) and then assign each
If your telemetry provider is Stackdriver or Prometheus, you can add [filter templates](/docs/guides/user/canary/config/filter-templates/) and then assign each
metric a filter template, if you want.

1. Click __Add Template__.

1. Provide a __Name__.
2. Provide a __Name__.

This is the name by which you can select it when configuring the specific
metric.

1. In the __Template__ field, enter an expression using the [FreeMarker](https://freemarker.apache.org/)
3. In the __Template__ field, enter an expression using the [FreeMarker](https://freemarker.apache.org/)
template language.

See the interpolation syntax [here](https://freemarker.apache.org/docs/dgui_quickstart_template.html).

The expression is expanded using the variable bindings specified via the __Extended
Params__ in any [canary
stage](/docs/v1/guides/user/canary/stage/#define-the-canary-stage) that uses this
Params__ in any [canary stage](/docs/guides/user/canary/stage/#define-the-canary-stage) that uses this
configuration.

These variable bindings are also implicitly available: `project`, `resourceType`, `scope`, `location`
Expand Down
Expand Up @@ -61,6 +61,6 @@ Params__, click __Add Field__.
this stage is using.

3. Add the value you want for that variable. You can use any literal or
[pipeline expression](/docs/guides/user/pipeline-expressions/).
[pipeline expression](/docs/guides/user/pipeline/expressions/).

![](/docs/guides/user/canary/config/extended_params.png)
2 changes: 1 addition & 1 deletion content/en/docs/guides/user/canary/judge/_index.md
Expand Up @@ -83,7 +83,7 @@ the ratio of "Pass" metrics out of the total number of metrics.

For example, if 9 of 10 metrics are classified as “Pass,” the score is 90%. The
threshold score for overall canary pass, marginal, or fail is specified in the
[canary configuration](/docs/v1/guides/user/canary/config/).
[canary configuration](/docs/guides/user/canary/config/).

While there are more complex scoring methodologies, the default judge
(NetflixACAJudge) is biased toward techniques that are simple to interpret and
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/user/canary/stage/_index.md
Expand Up @@ -42,7 +42,7 @@ other permutations, like multiple stages? -->
1. In the pipeline in which you will run the canary, click __Add stage__.

This pipeline needs to be in an application that has access to the [canary
configuration](/docs/v1/guides/user/canary/config/) you want to use.
configuration](/docs/guides/user/canary/config/) you want to use.

1. For __Type__ select __Canary__.

Expand Down Expand Up @@ -143,7 +143,7 @@ downstream of its dependencies.
which can be used to refine the scope of the analysis. These parameters can
provide variable bindings for use in the expansion of custom filter
templates [specified in the canary
config](/docs/v1/guides/user/canary/config/filter_templates/).
config](/docs/guides/user/canary/config/filter-templates/).

![Canary stage declaration](/docs/guides/user/canary/stage/metric_scope.png)

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/user/get-started/index.md
Expand Up @@ -23,7 +23,7 @@ started.
some things to check out:

- [Advanced configuration](/docs/setup/other_config/)
- [Productionize Spinnaker](/docs/etup/productionize/)
- [Productionize Spinnaker](/docs/setup/productionize/)

### Users (deploying with Spinnaker)

Expand Down
Expand Up @@ -67,11 +67,11 @@ And roll back by "1" revision, (Revision 4) will be active again. Roll back by
It's worth mentioning that you can parameterize the target resource to
roll back. It can point to something specified using pipeline parameters, and
upstream deploy stage, or another stage's outputs. See more details in the
[pipeline expressions guide](/docs/v1/guides/user/pipeline-expressions).
[pipeline expressions guide](/docs/guides/user/pipeline/expressions).

## Pitfalls

If the artifacts deployed in your manifest (Docker image, ConfigMap, Secret,
...) are not versioned, rolling back your manifest will likely not roll back
your code or config changes. See more details
[here](/docs/v1/guides/user/kubernetes-v2/best-practices#version-your-configmaps-and-secrets).
[here](/docs/guides/user/kubernetes-v2/best-practices#version-your-configmaps-and-secrets).
Expand Up @@ -16,7 +16,7 @@ For more details, see `helm template --help`.
> `helm install` once when
> bootstrapping your Kubernetes cluster.
> Note: Make sure that you have configured [artifact support](/docs/setup/artifacts)
> Note: Make sure that you have configured [artifact support](/docs/setup/other_config/artifacts/)
> in Spinnaker first. All Helm charts are fetched/stored as artifacts in
> Spinnaker. Read more in the [reference pages](/docs/reference/artifacts).
Expand Down
Expand Up @@ -76,8 +76,8 @@ This can be stored in GitHub or an object store (like GCS).

Changes to manifests can trigger pipelines. For more information:

* [Consuming GitHub Artifacts](/docs/guides/user/triggers/github)
* [Consuming GCS Artifacts](/docs/guides/user/triggers/gcs)
* [Consuming GitHub Artifacts](/docs/guides/user/pipeline/triggers/github)
* [Consuming GCS Artifacts](/docs/guides/user/pipeline/triggers/gcs)

Assuming you have declared an expected artifact upstream to your Deploy
manifest stage, you can reference it in the Deploy configuration:
Expand Down
Expand Up @@ -22,7 +22,7 @@ pipeline editor (only the __Name__ is required):
{{< figure src="./parameter.png" >}}

> See more details on how to provide parameters to pipelines programmatically in
> the [webhooks](/docs/guides/user/triggers/webhooks) page.
> the [webhooks](/docs/guides/user/pipeline/triggers/webhooks) page.
> Warning: there are several reserved parameter keys (names) that cause unexpected behavior and failures
> if overwritten by a pipeline parameter definition.
Expand Down Expand Up @@ -66,4 +66,4 @@ spec:

## More advanced parameterization

Please read the [pipeline expressions guide](/docs/guides/user/pipeline-expressions).
Please read the [pipeline expressions guide](/docs/guides/user/pipeline/expressions).

0 comments on commit 9a18ce6

Please sign in to comment.