Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(tweak): Put skeleton deploy config into includes file #87

Merged
merged 1 commit into from
Oct 26, 2023
Merged
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
4 changes: 4 additions & 0 deletions content/en/deployment/create-deploy-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}
2 changes: 1 addition & 1 deletion content/en/includes/dep-file/deploy-example.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ targets:
- <queryName2>
afterDeployment:
- pause:
untilApproved: true
untilApproved: true
requiresRoles:
- <role-name>
approvalExpiration:
Expand Down
6 changes: 6 additions & 0 deletions content/en/includes/dep-file/skeleton-config.md
Original file line number Diff line number Diff line change
@@ -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.

<details><summary><b>Click to view a skeleton deployment config file</b></summary>
<br>
{{< readfile file="/includes/dep-file/deploy-example.yaml" code="true" lang="yaml" >}}
</details>
7 changes: 3 additions & 4 deletions content/en/reference/deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,10 @@ armory template kubernetes [template-type] > deployment-template.yaml
{{< include "create-config.md" >}}


<details><summary>Show me an example deployment file</summary>
This file is in the <a href="https://github.com/armory/docs-cdaas-sample" target="_blank">armory/docs-cdaas-sample repo</a>.
## Deployment config file example

{{< include "dep-file/skeleton-config.md" >}}

{{< github repo="armory/docs-cdaas-sample" file="/deploy.yml" lang="yaml" options="" >}}
</details><br>

## {{% heading "nextSteps" %}}

Expand Down
7 changes: 2 additions & 5 deletions content/en/reference/deployment/config-file/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,9 @@ categories: ["Reference"]
tags: ["Deployment", "Deploy Config"]
---

<details><summary>Show an example deploy config file</summary>
<br>
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" >}}
</details>
{{< include "dep-file/skeleton-config.md" >}}



Expand Down
2 changes: 1 addition & 1 deletion content/en/remote-network-agent/install-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<details><summary>Show the values file</summary>
<details><summary>Click to view the values file</summary>
{{< github repo="armory-io/remote-network-agent-helm-chart" file="/values.yaml" lang="yaml" options="" >}}
</details><br>

Expand Down