Skip to content
Draft
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
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

#disableKinds = ["taxonomy", "taxonomyTerm"]
# disableKinds = ["taxonomy", "taxonomyTerm"]

# Highlighting config
pygmentsCodeFences = true
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: "Armory Agent for Kubernetes"
linkTitle: "Armory Agent for Kubernetes"
weight: 20
no_list: true
tags: ["Kubernetes", "Spinnaker"]
categories: ["Agent"]
description: >
The Armory Agent is a lightweight, scalable service that monitors your Kubernetes infrastructure and streams changes back to Spinnaker's Clouddriver service.
---
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Monitor the Armory Agent with Prometheus
linkTitle: Monitor
weight: 70
tags: ["Kubernetes", "Spinnaker", "Monitoring"]
categories: ["Agent"]
description: >
Learn how to configure Prometheus to get metrics from the Armory Agent and display them in a Grafana dashboard.
---
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-mtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Configure Mutual TLS Authentication"
linkTitle: "Configure mTLS"
weight: 40
tags: ["Kubernetes", "Spinnaker", "Configuration", "mTLS"]
categories: ["Agent"]
description: >
Configure mTLS authentication in the Armory Agent plugin and service.
---
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Armory Agent Configuration
linkTitle: Agent Config
weight: 50
tags: ["Kubernetes", "Spinnaker", "Configuration"]
categories: ["Agent"]
description: >
Learn how to configure the Armory Agent based on installation mode and environment restrictions. This guide contains a detailed list of configuration options.
---
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-permissions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Kubernetes Permissions for the Armory Agent"
linkTitle: "Permissions"
tags: ["Kubernetes", "Spinnaker", "Configuration", "Permissions"]
categories: ["Agent"]
description: >
Kubernetes permissions required by the Armory Agent.
weight: 65
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-plugin-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Plugin Configuration
linkTitle: Plugin Config
weight: 60
tags: ["Kubernetes", "Spinnaker", "Configuration", "Plugin"]
categories: ["Agent"]
description: >
This guide contains a detailed list of Armory Agent plugin configuration options for Clouddriver.
---
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Troubleshoot the Armory Agent Service and Plugin
linkTitle: Troubleshoot
tags: ["Kubernetes", "Spinnaker", "Troubleshooting"]
categories: ["Agent"]
weight: 80
description: >
Successful installation and startup messages, common errors, tips, and gRPC endpoint testing.
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-uninstall.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Uninstall the Agent
weight: 90
tags: ["Kubernetes", "Spinnaker", "Installation"]
categories: ["Agent"]
draft: false
---
![Proprietary](/images/proprietary.svg)
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/armory-agent/agent-vault.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Configure Vault Integration"
linkTitle: "Configure Vault"
tags: ["Kubernetes", "Spinnaker", "Configuration", "Vault"]
categories: ["Agent"]
weight: 41
description: >
Configure Armory Agent integration with Vault.
Expand Down
48 changes: 25 additions & 23 deletions content/en/docs/armory-agent/armory-agent-quick.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: "Armory Agent for Kubernetes Installation"
linkTitle: "Installation"
tags: ["Kubernetes", "Spinnaker", "Installation", "Quickstart"]
categories: ["Agent"]
description: >
Learn how to install the Armory Agent in your Kubernetes and Armory Enterprise environments.
weight: 30
Expand Down Expand Up @@ -450,12 +452,12 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t
If you have previously added the chart repo, update it with the following commands:

```bash
helm repo update
helm repo update
helm upgrade armory-agent armory-charts/agent-k8s
```

2. Create a namespace in the Kubernetes cluster where you are installing the Agent Service. In Agent mode, this is the same cluster as the deployment target for your app.

```bash
kubectl create namespace <agent-namespace>
```
Expand All @@ -468,7 +470,7 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t
- `--set cloudEnabled=false`
- `--set grpcUrl=localhost:9090`

These parameters control whether or not Agent attempts to connect to Armory Cloud services. They are required if you do not have a clientID and clientSecret and do not want to use Armory Cloud services.
These parameters control whether or not Agent attempts to connect to Armory Cloud services. They are required if you do not have a clientID and clientSecret and do not want to use Armory Cloud services.

If you want to connect to Armory Cloud services, you must include the following parameters with the values that Armory provided when running the `helm` command to install the Agent service:

Expand All @@ -480,25 +482,25 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t
4. Run one of the following Helm commands:

**Install with default configs in Agent mode:**

```bash
helm install armory-agent armory-charts/agent-k8s \
--set accountName=<my-k8s-cluster> \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API.
--set accountName=<my-k8s-cluster> \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API.
--set mode=agent \
--namespace=<agent-namespace> # Namespace where you want to install the Agent.
```

Depending on your environment and usage, set one or more of the following parameters:

```bash
# Disable the connection to Armory Cloud
# Disable the connection to Armory Cloud
--set cloudEnabled=false
--set grpcUrl=localhost:9090

# Authenticate to Armory Cloud
--set clientId=<your-clientId>
--set clientSecret=<your-Armory-Cloud-secret>
--set clientSecret=<your-Armory-Cloud-secret>

# Custom config options for Kubernetes
--set kubernetes=<kubernetes-options>

Expand All @@ -512,7 +514,7 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t
For information about additional options, see the [Agent config options]({{< ref "agent-options#configuration-options" >}}).

<details><summary>Show me an example</summary>

The following examples use the `imagePullSecrets` and `insecure` parameters, which may or may not be needed depending on your environment.

This example installs Agent service without a connection to Armory Cloud:
Expand All @@ -534,24 +536,24 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t

```bash
helm install armory-agent armory-charts/agent-k8s \
--set accountName=<my-k8s-cluster> \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API.
--set accountName=<my-k8s-cluster> \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API.
--set mode=infrastructure \
--namespace=<agent-namespace> # Namespace where you want to install the Agent.
```

Depending on your environment and usage, set one or more of the following parameters:

```bash
# Disable the connection to Armory Cloud
# Disable the connection to Armory Cloud
--set cloudEnabled=false
--set grpcUrl=localhost:9090

# Authenticate to Armory Cloud
--set clientId=<your-clientId>
--set clientSecret=<your-Armory-Cloud-secret>
--set clientId=<your-clientId>
--set clientSecret=<your-Armory-Cloud-secret>

# Custom config options for Kubernetes
--set kubernetes=<kubernetes-options>
--set kubernetes=<kubernetes-options>

# If TLS is disabled in your environment
--set insecure=true
Expand All @@ -563,15 +565,15 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t
For information about additional options, see the [Agent config options]({{< ref "agent-options#configuration-options" >}}).

<details><summary>Show me an example</summary>

The following examples use the `imagePullSecrets` and `insecure` parameters, which may or may not be needed depending on your environment.

This example installs Agent service without a connection to Armory Cloud:

```bash
helm install armory-agent --set mode=infrastructure,accountName=demo-account,imagePullSecrets=regcred,grpcUrl=spin-clouddriver-grpc:9091,insecure=true,cloudEnabled=false --set-file kubeconfig=$HOME/.kube/config --namespace dev armory-charts/agent-k8s
```

This example installs Agent service with a connection to Armory Cloud:

```bash
Expand All @@ -583,16 +585,16 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t

**Install with custom settings:**

1. Use `helm template` to generate a manifest.
1. Use `helm template` to generate a manifest.
```bash
helm template armory-agent armory-charts/agent-k8s \
--set-file kubeconfig=<path-to-your-kubeconfig>,armoryagent.yml=<path-to-agent-options>.yml \
--set-file kubeconfig=<path-to-your-kubeconfig>,armoryagent.yml=<path-to-agent-options>.yml \
--namespace=<agent-namespace> # Namespace where you want to install the Agent.
```

For `armoryagentyml`, create the file and customize it to meet your needs. For information about the options, see the [Agent config options]({{< ref "agent-options#configuration-options" >}}).
1. Install the helm chart using your template:

```bash
helm install armory-agent <local-helm-chart-name>
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ weight: 1
no_list: true
description: >
Options for deploying Armory Enterprise in an environment that is isolated from the internet.
aliases:
- /spinnaker-user-guides/plugin-creators/
- /docs/spinnaker-user-guides/plugin-creators/
categories: ["Installation"]
tags: ["Air-Gapped"]
---

{{< include "armory-license.md" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Air-Gapped with Halyard
weight: 3
description: >
Options for deploying Armory Enterprise using Armory Halyard in an air-gapped environment.
categories: ["Installation"]
tags: ["Air-Gapped", "Halyard"]
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Air-Gapped with the Armory Operator
weight: 2
description: >
Guide for hosting the Armory Enterprise BOM and Docker images in an air-gapped environment.
categories: ["Installation"]
tags: ["Operator", "Air-Gapped"]
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ aliases:
- /spinnaker/aws-container-marketplace/
description: >
Use the Armory Operator from the AWS Container Marketplace to deploy Armory Enterprise for Spinnaker in your Amazon Kubernetes (EKS) cluster.

categories: ["install"]
tags: ["AWS Marketplace", "Operator"]
---

{{% alert title="Note" %}}This document is intended for users who have purchased Armory's AWS Container Marketplace offering. It will not work if you have not subscribed to the Armory Container Marketplace offering.
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/installation/guide/configure-halyard.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ aliases:
- /docs/spinnaker-install-admin-guides/configure-halyard/
description: >
Configure Armory-extended Halyard profiles and storage.

categories: ["install", "config"]
tags: ["Halyard"]
---

## Overview of Armory Halyard
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/installation/guide/install-on-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ aliases:
- /spinnaker-install-admin-guides/install-on-aws/
description: >
Use Armory-extended Halyard to deploy Armory Enterprise in an AWS Kubernetes cluster or in an on-prem Kubernetes cluster with access to Amazon Secure Storage Service (S3).
categories: ["install"]
tags: ["AWS", "Halyard", "EKS"]
---

{{< include "armory-license.md" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ linkTitle: Install in OpenShift
weight: 5
description: >
Use the Armory Operator from the Red Hat Marketplace to deploy Armory Enterprise in your OpenShift cluster.
categories: ["install"]
tags: ["Red Hat", "OpenShift", "Operator"]
---

> This document is intended for users who have purchased the Armory Red Hat Marketplace offering. It will not work if you have not purchased the Armory Operator. Please contact [Armory](mailto:hello@armory.io) if you're interested in a Red Hat Marketplace Private Offer.
Expand Down
9 changes: 9 additions & 0 deletions layouts/partials/hooks/head-end.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
{{ if .Params.tags }}
{{ $pageTags := (delimit .Params.tags ", ") }}
<meta class="elastic" name="tags" content="{{ $pageTags }}">
{{ end }}
{{ if .Params.categories }}
{{ $pageCategories := (delimit .Params.categories ", ") }}
<meta class="elastic" name="categories" content="{{ $pageCategories }}">
{{ end }}

<script type="text/javascript">
(function(){
window.ldfdr = window.ldfdr || {};
Expand Down