Skip to content

Commit 2d06908

Browse files
authored
docs(plugins): Spinnaker Plugins section (#1884)
* docs(plugins): DOC-718 Spinnaker Plugins section * add link to armory.io PE page * policy engine - move release notes to separate age * create includes/plugin directory * add directions to create client creds for Spinnaker to CDaaS plugin * update plugins landing page * fix plugin-guide section redirect * update page descriptions * word tweak on landing page * remove "Armory" from plugin names in compat matrix on landing page * update landing page blurb * modify readfile shortcode to throw error add plugin compat matrix include
1 parent 22c29bf commit 2d06908

File tree

423 files changed

+1042
-982
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

423 files changed

+1042
-982
lines changed

config-generated.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ weight = 3
9797
url = "/continuous-deployment/"
9898

9999
[[menu.main]]
100-
name = "Scale Agent"
100+
name = "Spinnaker Plugins"
101101
weight = 4
102-
url = "/scale-agent/"
102+
url = "/plugins/"
103103

104104
[[menu.main]]
105105
name = "Support"

config-modules.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ menu:
7474
- name: Armory CD
7575
weight: 3
7676
url: /continuous-deployment/
77-
- name: Scale Agent
77+
- name: Spinnaker Plugins
7878
weight: 4
79-
url: /scale-agent/
79+
url: /plugins/
8080
- name: Support
8181
weight: 5
8282
url: "https://support.armory.io/"

config.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,9 @@ weight = 1
126126
url = "/continuous-deployment/"
127127

128128
[[menu.main]]
129-
name = "Scale Agent"
129+
name = "Spinnaker Plugins"
130130
weight = 4
131-
url = "/scale-agent/"
131+
url = "/plugins/"
132132

133133
[[menu.main]]
134134
name = "Support"

content/en/_index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ <h3 class="text-center mt-3">
5353
<a class="btn btn-secondary white" href="{{< relref "/continuous-deployment/" >}}">
5454
View Documentation
5555
</a>
56-
<a class="small-link mt-3" href="https://www.armory.io/armory-enterprise-spinnaker/" target="_blank">
56+
<a class="small-link mt-3" href="https://www.armory.io/products/continuous-deployment-self-hosted/" target="_blank">
5757
<span>Learn More</span>
5858
<i>&LongRightArrow;</i>
5959
</a>
@@ -71,10 +71,10 @@ <h3 class="text-center mt-3">
7171
Kubernetes deployments at massive scale, without the massive headache
7272
</p>
7373
<div class="link-container">
74-
<a class="btn btn-secondary white" href="{{< relref "/scale-agent/" >}}">
74+
<a class="btn btn-secondary white" href="{{< relref "/plugins/scale-agent/" >}}">
7575
View Documentation
7676
</a>
77-
<a class="small-link mt-3" href="https://www.armory.io/armory-enterprise-spinnaker/armory-agent-for-kubernetes/" target="_blank">
77+
<a class="small-link mt-3" href="https://www.armory.io/products/scale-agent-for-spinnaker-kubernetes/" target="_blank">
7878
<span>Learn More</span>
7979
<i>&LongRightArrow;</i>
8080
</a>

content/en/cd-as-a-service/plugin-spinnaker.md

+5-534
Large diffs are not rendered by default.

content/en/cd-as-a-service/release-notes/requirements.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Armory CD-as-a-Service uses agents that run in target Kubernetes clusters to com
1111

1212
There are no additional requirements for installing the agents that Armory CD-as-a-Service uses. For information about how to install these agents, see [Enable the Armory CD-as-a-Service Remote Network Agent in target Kubernetes clusters]({{< ref "plugin-spinnaker#enable-the-armory-cd-as-a-service-remote-network-agent-in-target-kubernetes-clusters" >}}) or {{< linkWithTitle "get-started" >}}.
1313

14-
> If you are using the Armory Scale Agent for Spinnaker and Kubernetes, that is a separate agent from the Remote Networking Agent. It has its own requirements. For more information, see {{< linkWithTitle "scale-agent/install/_index.md" >}}.
14+
> If you are using the Armory Scale Agent for Spinnaker and Kubernetes, that is a separate agent from the Remote Networking Agent. It has its own requirements. For more information, see {{< linkWithTitle "plugins/scale-agent/_index.md" >}}.
1515
1616
## Deployment target
1717

content/en/continuous-deployment/Overview/architecture.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Rosco is the "bakery" service. It is a wrapper around Hashicorp's Packer command
6262

6363
### Armory Scale Agent for Spinnaker and Kubernetes
6464

65-
The {{< linkWithTitle "scale-agent/_index.md" >}} is a lightweight, scalable service that monitors your Kubernetes infrastructure and streams changes back to the Clouddriver service.
65+
The {{< linkWithTitle "plugins/scale-agent/_index.md" >}} is a lightweight, scalable service that monitors your Kubernetes infrastructure and streams changes back to the Clouddriver service.
6666

6767
### Dinghy
6868

@@ -73,7 +73,7 @@ The {{< linkWithTitle "scale-agent/_index.md" >}} is a lightweight, scalable ser
7373

7474
### Policy Engine
7575

76-
The [Armory Policy Engine]({{< ref "policy-engine" >}}) is designed to allow enterprises more complete control of their software delivery process by providing them with the hooks necessary to perform more extensive verification of their pipelines and processes in Spinnaker. This policy engine is backed by Open Policy Agent(OPA) and uses input style documents to perform validation of pipelines during save time and runtime
76+
The [Armory Policy Engine]({{< ref "plugins/policy-engine" >}}) is designed to allow enterprises more complete control of their software delivery process by providing them with the hooks necessary to perform more extensive verification of their pipelines and processes in Spinnaker. This policy engine is backed by Open Policy Agent(OPA) and uses input style documents to perform validation of pipelines during save time and runtime
7777

7878
### Terraformer
7979

content/en/continuous-deployment/_index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Armory Continuous Deployment
33
weight: 10
44
no_list: true
55
description: >
6-
Guides and release notes for Armory Continuous Deployment products including Armory Continuous Deployment Self-Hosted, Armory Operator, and Armory Scale Agent for Spinnaker and Kubernetes.
6+
Guides and release notes for Armory Continuous Deployment Self-Hosted and the Armory Operators.
77
---
88

99
## What is Armory Continuous Deployment?
@@ -24,6 +24,8 @@ The [Armory Operator]({{< ref "armory-operator" >}}) is a Kubernetes Operator th
2424

2525
The open source [Spinnaker Operator](https://github.com/armory/spinnaker-operator) provides features to deploy and manage open source Spinnaker.
2626

27-
### Armory Scale Agent for Spinnaker and Kubernetes
27+
### Plugins for Spinnaker and Armory CD
28+
29+
{{% readfile "/includes/plugins/plugin-compat-matrix.md" %}}
30+
2831

29-
The {{< linkWithTitle "scale-agent/_index.md" >}} is a lightweight, scalable service that monitors your Kubernetes infrastructure and streams changes back to Spinnaker's Clouddriver service.

content/en/continuous-deployment/armory-admin/caching-agents-concept.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ When using a cache store like Redis that works across multiple Clouddriver insta
5959
## Next steps
6060

6161
* {{< linkWithTitle "caching-agents-config.md" >}}
62-
* If you are using Kubernetes and would like to use a different method for cataloging your Kubernetes infrastructure, see {{< linkWithTitle "scale-agent/_index.md" >}}.
62+
* If you are using Kubernetes and would like to use a different method for cataloging your Kubernetes infrastructure, see {{< linkWithTitle "plugins/scale-agent/_index.md" >}}.

content/en/continuous-deployment/feature-status/continuous-deployment-matrix/_index.md

-34
Original file line numberDiff line numberDiff line change
@@ -422,40 +422,6 @@ The following table lists the supported pipeline triggers:
422422
| Webhook | All supported versions | |
423423

424424

425-
426-
## Policy Engine
427-
428-
[![Generally available](/images/ga.svg)]({{< ref "release-definitions#ga" >}}) ![Proprietary](/images/proprietary.svg)
429-
430-
The [Policy Engine]({{< ref "policy-engine" >}}) gives you the ability to ensure any pipeline meets certain requirements that you specify.
431-
432-
{{< include "policy-engine/plugin-compat-matrix.md" >}}
433-
434-
**OPA requirements**
435-
436-
The Policy Engine requires an Open Policy Agent server. This can be deployed in the same cluster as Armory Continuous Deployment or in an external cluster.
437-
438-
The following table lists the requirements:
439-
440-
| Requirement | Version | Note |
441-
| ----------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
442-
| OPA Server | 0.12.x or later | Specifically, the v1 API must be available. When you specify the OPA server URL in the Armory Continuous Deployment configs, include `v1` in the URL: `http://<your-opa-server>:<port>/v1`. |
443-
444-
**Supported validations**
445-
446-
| Validation | Armory Continuous Deployment Version | Note |
447-
| -------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------- |
448-
| Save time validation | All supported versions | If no policies are set, you cannot save any pipelines until you set any policy or turn off save time validation. |
449-
| Runtime validation | All supported versions | If no policies are set, no policy enforcement occurs and pipelines run as they do normally. |
450-
451-
## Scale Agent
452-
453-
[![Generally available](/images/ga.svg)]({{< ref "release-definitions#ga" >}})![Proprietary](/images/proprietary.svg)
454-
455-
{{< include "scale-agent/agent-compat-matrix.md" >}}
456-
457-
For a full list of previous releases, see this [page](https://armory.jfrog.io/artifactory/manifests/).
458-
459425
## Secret stores
460426

461427
[![Generally available](/images/ga.svg)]({{< ref "release-definitions#ga" >}}) ![OSS](/images/oss.svg) ![Proprietary](/images/proprietary.svg)

content/en/continuous-deployment/plugin-guide/_index.md

-41
This file was deleted.

content/en/continuous-deployment/plugin-guide/cdaas-spinnaker.md

-8
This file was deleted.

content/en/contribute/create/guides/shortcodes/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Renders as:
7474

7575
See the {{< linkWithTitle best-practices.md >}} page...
7676

77-
See this page: {{< linkWithTitle "scale-agent/tasks/service-monitor.md" >}}.
77+
See this page: {{< linkWithTitle "plugins/scale-agent/tasks/service-monitor.md" >}}.
7878

7979
### Google suite shortcode
8080

content/en/includes/breaking-changes/bc-plug-version-lts-227.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The following table lists the plugins and their required minimum version:
44

55
| Plugin | Version |
66
|---------|-----------|
7-
| [Armory Agent for Kubernetes Clouddriver Plugin]({{< ref "scale-agent/release-notes/agent-plugin" >}}) | 0.10.0 |
7+
| [Armory Agent for Kubernetes Clouddriver Plugin]({{< ref "plugins/scale-agent/release-notes/agent-plugin" >}}) | 0.10.0 |
88
| App Name | 0.2.0 |
99
| [AWS Lambda](https://github.com/spinnaker-plugins/aws-lambda-deployment-plugin-spinnaker/releases) | 1.0.9 |
1010
| [Evaluate Artifacts](https://github.com/armory-plugins/evaluate-artifacts-releases/releases) | 0.1.1 |

content/en/includes/breaking-changes/bc-plugin-compatibility-2-28-0.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The following table lists the plugins and their required minimum version:
66

77
| Plugin | Version |
88
| -------------------------------------------------------------------------------------------------- | ------- |
9-
| [Scale Agent for Spinnaker and Kubernetes Clouddriver Plugin]({{< ref "scale-agent/_index.md" >}}) | 0.11.0 |
9+
| [Scale Agent for Spinnaker and Kubernetes Clouddriver Plugin]({{< ref "plugins/scale-agent/_index.md" >}}) | 0.11.0 |
1010
| App Name | 0.2.0 |
1111
| [AWS Lambda](https://github.com/spinnaker-plugins/aws-lambda-deployment-plugin-spinnaker/releases) | 1.0.10 |
1212
| [Evaluate Artifacts](https://github.com/armory-plugins/evaluate-artifacts-releases/releases) | 0.1.1 |
+7-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
All network traffic is encrypted while in transit.
2-
3-
Encryption in transit is over HTTPS using TLS encryption. When using Armory-provided software for both the client and server, these connections are secured by TLS 1.2. Certain APIs support older TLS versions for clients that do not support 1.2.
4-
5-
Encryption at rest uses AES256 encryption.
6-
71
The following network endpoints are used for communication into Armory CD-as-a-Service:
82

93
| DNS | Port | Protocol | Description |
104
| ------------------------- | ---- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
115
| agent-hub.cloud.armory.io | 443 | TLS enabled gRPC over HTTP/2<br>TLS version 1.2 | Remote Network Agent Hub connection; Agent Hub routes deployment commands to RNAs and caches data received from them. Agent Hub does not require direct network access to the RNAs since they connect to Agent Hub through an encrypted, long-lived gRPC HTTP2 connection. Agent Hub uses this connection to send deployment commands to the RNA for execution. |
126
| api.cloud.armory.io | 443 | HTTP over TLS (HTTPS)<br>TLS version 1.2 | Armory REST API; Clients connect to these APIs to interact with Armory CD-as-a-Service. |
13-
| auth.cloud.armory.io | 443 | HTTP over TLS (HTTPS)<br>TLS version 1.2 | OIDC Service; The Open ID Connect (OIDC) service is used to authorize and authenticate machines and users. The RNAs, Armory Continuous Deployment (Spinnaker) plugin, and other services all authenticate against this endpoint. The service provides an identity token that can be passed to the Armory API and Agent Hub. |
7+
| auth.cloud.armory.io | 443 | HTTP over TLS (HTTPS)<br>TLS version 1.2 | OIDC Service; The Open ID Connect (OIDC) service is used to authorize and authenticate machines and users. The RNAs, Armory Continuous Deployment (Spinnaker) plugin, and other services all authenticate against this endpoint. The service provides an identity token that can be passed to the Armory API and Agent Hub. |
8+
9+
All network traffic is encrypted while in transit.
10+
11+
Encryption in transit is over HTTPS using TLS encryption. When using Armory-provided software for both the client and server, these connections are secured by TLS 1.2. Certain APIs support older TLS versions for clients that do not support 1.2.
12+
13+
Encryption at rest uses AES256 encryption.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
| Plugin | Spinnaker | Armory CD |
2+
|:-------|:--------:|:--------:|
3+
| {{< linkWithLinkTitle "plugins/cdaas-spinnaker.md" >}}<br>{{% getPageDesc "/plugins/cdaas-spinnaker.md" %}} | 1.24+ | 2.24+<br>(included with Armory CD)|
4+
| {{< linkWithLinkTitle "plugins/plugin-k8s-custom-resource-status.md" >}}<br>{{% getPageDesc "/plugins/plugin-k8s-custom-resource-status.md" %}} | 1.27+ | 2.27+ |
5+
| {{< linkWithLinkTitle "plugins/policy-engine/_index.md" >}}<br>{{% getPageDesc "/plugins/policy-engine/_index.md" %}} | 1.26+ | 2.26+ |
6+
| {{< linkWithLinkTitle "plugins/scale-agent/_index.md" >}}<br>{{% getPageDesc "/plugins/scale-agent/_index.md" %}} | 1.26+ | 2.26+ |
+1-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
Armory helps software teams ship better software, faster. Armory Continuous Deployment (Armory CD) is an enterprise-grade distribution of Spinnaker™ that runs in your Kubernetes cluster. Armory CD is an extension of open source Spinnaker and includes all of those benefits as well as the following:
2-
3-
- [Pipelines as Code (Dinghy)]({{< ref "using-dinghy" >}}) allows you to store Spinnaker pipelines in Github and manage them like you would manage code, including version control, templatization, and modularization. Spinnaker pipelines are flexible and customizable series of deployment stages. Combine all these to rapidly and repeatably scale pipelines in your Spinnaker deployment.
4-
- [Policy Engine]({{< ref "policy-engine" >}}) helps you meet compliance requirements based on custom policies you set. You can configure the Policy Engine to verify that your pipelines meet certain requirements at save time or at runtime. You can use the Policy Engine with Armory Continuous Deployment (Armory CD) and open source Spinnaker.
5-
- [Terraform integration]({{< ref "terraform-use-integration" >}}) allows you to use your existing Terraform scripts to plan and create infrastructure as part a Spinnaker pipeline. You can deploy your application and infrastructure all in a single pipeline.
6-
- Integrations with many of your existing tools. For a full list, see [Integrations](https://www.armory.io/armory-spinnaker/integrations/).
1+
Armory helps software teams ship better software, faster. Armory Continuous Deployment (Armory CD) is an enterprise-grade distribution of Spinnaker™ that runs in your Kubernetes cluster. Armory CD extends Spinnaker with both essential and optional premium plugins. See the [Armory Continuous Deployment Self-Hosted product page](https://www.armory.io/products/continuous-deployment-self-hosted/) for complete list of featues and pricing.

0 commit comments

Comments
 (0)