diff --git a/config.toml b/config.toml index 6e390c8aae..a797c1ee24 100644 --- a/config.toml +++ b/config.toml @@ -18,7 +18,7 @@ defaultContentLanguageInSubdir = false # Useful when translating. enableMissingTranslationPlaceholders = true -#disableKinds = ["taxonomy", "taxonomyTerm"] +# disableKinds = ["taxonomy", "taxonomyTerm"] # Highlighting config pygmentsCodeFences = true diff --git a/content/en/docs/armory-agent/_index.md b/content/en/docs/armory-agent/_index.md index 94c3561f39..9d5ef5f243 100644 --- a/content/en/docs/armory-agent/_index.md +++ b/content/en/docs/armory-agent/_index.md @@ -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. --- diff --git a/content/en/docs/armory-agent/agent-monitoring.md b/content/en/docs/armory-agent/agent-monitoring.md index 7603876953..3263d5c7d5 100644 --- a/content/en/docs/armory-agent/agent-monitoring.md +++ b/content/en/docs/armory-agent/agent-monitoring.md @@ -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. --- diff --git a/content/en/docs/armory-agent/agent-mtls.md b/content/en/docs/armory-agent/agent-mtls.md index ab88bb73c3..e3b20e78fd 100644 --- a/content/en/docs/armory-agent/agent-mtls.md +++ b/content/en/docs/armory-agent/agent-mtls.md @@ -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. --- diff --git a/content/en/docs/armory-agent/agent-options.md b/content/en/docs/armory-agent/agent-options.md index c4c773e4c6..7cec3b284e 100644 --- a/content/en/docs/armory-agent/agent-options.md +++ b/content/en/docs/armory-agent/agent-options.md @@ -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. --- diff --git a/content/en/docs/armory-agent/agent-permissions.md b/content/en/docs/armory-agent/agent-permissions.md index 8f56faa504..f1b79e57ed 100644 --- a/content/en/docs/armory-agent/agent-permissions.md +++ b/content/en/docs/armory-agent/agent-permissions.md @@ -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 diff --git a/content/en/docs/armory-agent/agent-plugin-options.md b/content/en/docs/armory-agent/agent-plugin-options.md index 8f28ca2aa8..a9beb53f34 100644 --- a/content/en/docs/armory-agent/agent-plugin-options.md +++ b/content/en/docs/armory-agent/agent-plugin-options.md @@ -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. --- diff --git a/content/en/docs/armory-agent/agent-troubleshooting.md b/content/en/docs/armory-agent/agent-troubleshooting.md index 2ebe84e32b..7804abe24c 100644 --- a/content/en/docs/armory-agent/agent-troubleshooting.md +++ b/content/en/docs/armory-agent/agent-troubleshooting.md @@ -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. diff --git a/content/en/docs/armory-agent/agent-uninstall.md b/content/en/docs/armory-agent/agent-uninstall.md index e310dfb16c..68ea96cb22 100644 --- a/content/en/docs/armory-agent/agent-uninstall.md +++ b/content/en/docs/armory-agent/agent-uninstall.md @@ -1,6 +1,8 @@ --- title: Uninstall the Agent weight: 90 +tags: ["Kubernetes", "Spinnaker", "Installation"] +categories: ["Agent"] draft: false --- ![Proprietary](/images/proprietary.svg) diff --git a/content/en/docs/armory-agent/agent-vault.md b/content/en/docs/armory-agent/agent-vault.md index 7f69ececef..86968834c7 100644 --- a/content/en/docs/armory-agent/agent-vault.md +++ b/content/en/docs/armory-agent/agent-vault.md @@ -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. diff --git a/content/en/docs/armory-agent/armory-agent-quick.md b/content/en/docs/armory-agent/armory-agent-quick.md index 67f0398d46..81b3390552 100644 --- a/content/en/docs/armory-agent/armory-agent-quick.md +++ b/content/en/docs/armory-agent/armory-agent-quick.md @@ -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 @@ -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 ``` @@ -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: @@ -480,10 +482,10 @@ 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= \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API. + --set accountName= \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API. --set mode=agent \ --namespace= # Namespace where you want to install the Agent. ``` @@ -491,14 +493,14 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t 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= - --set clientSecret= - + --set clientSecret= + # Custom config options for Kubernetes --set kubernetes= @@ -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" >}}).
Show me an example - + 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: @@ -534,7 +536,7 @@ 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= \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API. + --set accountName= \ # Provide a descriptive name. This name gets used in the UI and Armory Cloud API. --set mode=infrastructure \ --namespace= # Namespace where you want to install the Agent. ``` @@ -542,16 +544,16 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t 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= - --set clientSecret= - + --set clientId= + --set clientSecret= + # Custom config options for Kubernetes - --set kubernetes= + --set kubernetes= # If TLS is disabled in your environment --set insecure=true @@ -563,7 +565,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" >}}).
Show me an example - + 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: @@ -571,7 +573,7 @@ On the Kubernetes cluster where you want to install the Agent Service, perform t ```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 @@ -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=,armoryagent.yml=.yml \ + --set-file kubeconfig=,armoryagent.yml=.yml \ --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 ``` diff --git a/content/en/docs/installation/guide/air-gapped/_index.md b/content/en/docs/installation/guide/air-gapped-install/_index.md similarity index 97% rename from content/en/docs/installation/guide/air-gapped/_index.md rename to content/en/docs/installation/guide/air-gapped-install/_index.md index f01ef4cf01..91029d9106 100644 --- a/content/en/docs/installation/guide/air-gapped/_index.md +++ b/content/en/docs/installation/guide/air-gapped-install/_index.md @@ -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" >}} diff --git a/content/en/docs/installation/guide/air-gapped/ag-halyard.md b/content/en/docs/installation/guide/air-gapped-install/ag-halyard.md similarity index 99% rename from content/en/docs/installation/guide/air-gapped/ag-halyard.md rename to content/en/docs/installation/guide/air-gapped-install/ag-halyard.md index 35f9b89935..0684212df9 100644 --- a/content/en/docs/installation/guide/air-gapped/ag-halyard.md +++ b/content/en/docs/installation/guide/air-gapped-install/ag-halyard.md @@ -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 diff --git a/content/en/docs/installation/guide/air-gapped/ag-operator.md b/content/en/docs/installation/guide/air-gapped-install/ag-operator.md similarity index 99% rename from content/en/docs/installation/guide/air-gapped/ag-operator.md rename to content/en/docs/installation/guide/air-gapped-install/ag-operator.md index 29a29cac34..0866b46081 100644 --- a/content/en/docs/installation/guide/air-gapped/ag-operator.md +++ b/content/en/docs/installation/guide/air-gapped-install/ag-operator.md @@ -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 diff --git a/content/en/docs/installation/guide/aws-container-marketplace.md b/content/en/docs/installation/guide/aws-container-marketplace.md index 235ba6c3ba..1d37bef120 100644 --- a/content/en/docs/installation/guide/aws-container-marketplace.md +++ b/content/en/docs/installation/guide/aws-container-marketplace.md @@ -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. diff --git a/content/en/docs/installation/guide/configure-halyard.md b/content/en/docs/installation/guide/configure-halyard.md index 738aee8f01..048eaba030 100644 --- a/content/en/docs/installation/guide/configure-halyard.md +++ b/content/en/docs/installation/guide/configure-halyard.md @@ -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 diff --git a/content/en/docs/installation/guide/install-on-aws.md b/content/en/docs/installation/guide/install-on-aws.md index ee161b4735..cbe49d1871 100644 --- a/content/en/docs/installation/guide/install-on-aws.md +++ b/content/en/docs/installation/guide/install-on-aws.md @@ -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" >}} diff --git a/content/en/docs/installation/guide/install-redhat-marketplace.md b/content/en/docs/installation/guide/install-redhat-marketplace.md index da8020d6d7..436a9c5a23 100644 --- a/content/en/docs/installation/guide/install-redhat-marketplace.md +++ b/content/en/docs/installation/guide/install-redhat-marketplace.md @@ -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. diff --git a/layouts/partials/hooks/head-end.html b/layouts/partials/hooks/head-end.html index 2c645270eb..9865aae822 100644 --- a/layouts/partials/hooks/head-end.html +++ b/layouts/partials/hooks/head-end.html @@ -1,3 +1,12 @@ +{{ if .Params.tags }} +{{ $pageTags := (delimit .Params.tags ", ") }} + +{{ end }} +{{ if .Params.categories }} +{{ $pageCategories := (delimit .Params.categories ", ") }} + +{{ end }} +