From 2e08e0fed396297e74a8471f2dc4f3cfc5b71446 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Wed, 25 Oct 2023 12:36:26 -0500 Subject: [PATCH] docs(tweak): Put skeleton deploy config into includes file --- content/en/deployment/create-deploy-config.md | 4 ++++ content/en/includes/dep-file/deploy-example.yaml | 2 +- content/en/includes/dep-file/skeleton-config.md | 6 ++++++ content/en/reference/deployment/_index.md | 7 +++---- content/en/reference/deployment/config-file/_index.md | 7 ++----- content/en/remote-network-agent/install-helm.md | 2 +- 6 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 content/en/includes/dep-file/skeleton-config.md diff --git a/content/en/deployment/create-deploy-config.md b/content/en/deployment/create-deploy-config.md index 2203edd8..47c4ea12 100644 --- a/content/en/deployment/create-deploy-config.md +++ b/content/en/deployment/create-deploy-config.md @@ -16,6 +16,10 @@ Make sure you have [installed the CD-as-a-Service CLI]({{< ref "cli" >}}), which {{< include "create-config.md" >}} +## Deployment config file example + +{{< include "dep-file/skeleton-config.md" >}} + ## {{% heading "nextSteps" %}} * {{< linkWithTitle "reference/deployment/config-file/_index.md" >}} diff --git a/content/en/includes/dep-file/deploy-example.yaml b/content/en/includes/dep-file/deploy-example.yaml index ca1c9e6d..9a7ab9aa 100644 --- a/content/en/includes/dep-file/deploy-example.yaml +++ b/content/en/includes/dep-file/deploy-example.yaml @@ -36,7 +36,7 @@ targets: - afterDeployment: - pause: - untilApproved: true + untilApproved: true requiresRoles: - approvalExpiration: diff --git a/content/en/includes/dep-file/skeleton-config.md b/content/en/includes/dep-file/skeleton-config.md new file mode 100644 index 00000000..d719a29d --- /dev/null +++ b/content/en/includes/dep-file/skeleton-config.md @@ -0,0 +1,6 @@ +Expand to see a skeleton config file for a deployment to Kubernetes. All all config options are listed for each section. + +
Click to view a skeleton deployment config file +
+{{< readfile file="/includes/dep-file/deploy-example.yaml" code="true" lang="yaml" >}} +
\ No newline at end of file diff --git a/content/en/reference/deployment/_index.md b/content/en/reference/deployment/_index.md index b6b3b7e8..5dd3cec3 100644 --- a/content/en/reference/deployment/_index.md +++ b/content/en/reference/deployment/_index.md @@ -51,11 +51,10 @@ armory template kubernetes [template-type] > deployment-template.yaml {{< include "create-config.md" >}} -
Show me an example deployment file -This file is in the armory/docs-cdaas-sample repo. +## Deployment config file example + +{{< include "dep-file/skeleton-config.md" >}} -{{< github repo="armory/docs-cdaas-sample" file="/deploy.yml" lang="yaml" options="" >}} -

## {{% heading "nextSteps" %}} diff --git a/content/en/reference/deployment/config-file/_index.md b/content/en/reference/deployment/config-file/_index.md index f5f8d06b..1ede758e 100644 --- a/content/en/reference/deployment/config-file/_index.md +++ b/content/en/reference/deployment/config-file/_index.md @@ -8,12 +8,9 @@ categories: ["Reference"] tags: ["Deployment", "Deploy Config"] --- -
Show an example deploy config file -
-The following is a skeleton for a deployment to Kubernetes. All all config options are listed for each section. +## Deployment config file example -{{< readfile file="/includes/dep-file/deploy-example.yaml" code="true" lang="yaml" >}} -
+{{< include "dep-file/skeleton-config.md" >}} diff --git a/content/en/remote-network-agent/install-helm.md b/content/en/remote-network-agent/install-helm.md index 87cf55f8..9321cbb7 100644 --- a/content/en/remote-network-agent/install-helm.md +++ b/content/en/remote-network-agent/install-helm.md @@ -46,7 +46,7 @@ Installation using Helm consists of the following steps: 1. [Generate and preview the manifests](#generate-and-preview-the-manifests) 1. [Install the RNA](#install-the-rna) -
Show the values file +
Click to view the values file {{< github repo="armory-io/remote-network-agent-helm-chart" file="/values.yaml" lang="yaml" options="" >}}