mirror of
https://github.com/argoproj/argo-cd
synced 2026-04-21 17:07:16 +00:00
docs: add CRD specification example files to docs (#14021)
* docs: add CRD specification example files to docs Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * pages for declarative files, too Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> --------- Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> Co-authored-by: pasha-codefresh <pavel@codefresh.io>
This commit is contained in:
Michael Crenshaw
GitHub
parent
a952b016ce
commit
698aef34ec
13 changed files with 95 additions and 15 deletions
|
|
@ -0,0 +1,7 @@
|
|||
# ApplicationSet Specification
|
||||
|
||||
The following describes all the available fields of an ApplicationSet:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/applicationset.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-cm-yaml.md
Normal file
7
docs/operator-manual/argocd-cm-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-cm.yaml example
|
||||
|
||||
An example of an argocd-cm.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-cm.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-cmd-params-cm-yaml.md
Normal file
7
docs/operator-manual/argocd-cmd-params-cm-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-cmd-params-cm.yaml example
|
||||
|
||||
An example of an argocd-cmd-params-cm.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-cmd-params-cm.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-rbac-cm-yaml.md
Normal file
7
docs/operator-manual/argocd-rbac-cm-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-rbac-cm.yaml example
|
||||
|
||||
An example of an argocd-rbac-cm.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-rbac-cm.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-repo-creds-yaml.md
Normal file
7
docs/operator-manual/argocd-repo-creds-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-repo-creds.yaml example
|
||||
|
||||
An example of an argocd-repo-creds.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-repo-creds.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-repositories-yaml.md
Normal file
7
docs/operator-manual/argocd-repositories-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-repositories.yaml example
|
||||
|
||||
An example of an argocd-repositories.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-repositories.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-secret-yaml.md
Normal file
7
docs/operator-manual/argocd-secret-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-secret.yaml example
|
||||
|
||||
An example of an argocd-secret.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-secret.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-ssh-known-hosts-cm-yaml.md
Normal file
7
docs/operator-manual/argocd-ssh-known-hosts-cm-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-ssh-known-hosts-cm.yaml example
|
||||
|
||||
An example of an argocd-ssh-known-hosts-cm.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-ssh-known-hosts-cm.yaml!}
|
||||
```
|
||||
7
docs/operator-manual/argocd-tls-certs-cm-yaml.md
Normal file
7
docs/operator-manual/argocd-tls-certs-cm-yaml.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# argocd-tls-certs-cm.yaml example
|
||||
|
||||
An example of an argocd-tls-certs-cm.yaml file:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/argocd-tls-certs-cm.yaml!}
|
||||
```
|
||||
|
|
@ -8,16 +8,16 @@ All resources, including `Application` and `AppProject` specs, have to be instal
|
|||
|
||||
### Atomic configuration
|
||||
|
||||
| Sample File | Resource Name | Kind | Description |
|
||||
|-------------|---------------|------|-------------|
|
||||
| [`argocd-cm.yaml`](argocd-cm.yaml) | argocd-cm | ConfigMap | General Argo CD configuration |
|
||||
| [`argocd-repositories.yaml`](argocd-repositories.yaml) | my-private-repo / istio-helm-repo / private-helm-repo / private-repo | Secrets | Sample repository connection details |
|
||||
| [`argocd-repo-creds.yaml`](argocd-repo-creds.yaml) | argoproj-https-creds / argoproj-ssh-creds / github-creds / github-enterprise-creds | Secrets | Sample repository credential templates |
|
||||
| [`argocd-cmd-params-cm.yaml`](argocd-cmd-params-cm.yaml) | argocd-cmd-params-cm | ConfigMap | Argo CD env variables configuration |
|
||||
| [`argocd-secret.yaml`](argocd-secret.yaml) | argocd-secret | Secret | User Passwords, Certificates (deprecated), Signing Key, Dex secrets, Webhook secrets |
|
||||
| [`argocd-rbac-cm.yaml`](argocd-rbac-cm.yaml) | argocd-rbac-cm | ConfigMap | RBAC Configuration |
|
||||
| [`argocd-tls-certs-cm.yaml`](argocd-tls-certs-cm.yaml) | argocd-tls-certs-cm | ConfigMap | Custom TLS certificates for connecting Git repositories via HTTPS (v1.2 and later) |
|
||||
| [`argocd-ssh-known-hosts-cm.yaml`](argocd-ssh-known-hosts-cm.yaml) | argocd-ssh-known-hosts-cm | ConfigMap | SSH known hosts data for connecting Git repositories via SSH (v1.2 and later) |
|
||||
| Sample File | Resource Name | Kind | Description |
|
||||
|-----------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------|--------------------------------------------------------------------------------------|
|
||||
| [`argocd-cm.yaml`](argocd-cm-yaml.md) | argocd-cm | ConfigMap | General Argo CD configuration |
|
||||
| [`argocd-repositories.yaml`](argocd-repositories-yaml.md) | my-private-repo / istio-helm-repo / private-helm-repo / private-repo | Secrets | Sample repository connection details |
|
||||
| [`argocd-repo-creds.yaml`](argocd-repo-creds.yaml) | argoproj-https-creds / argoproj-ssh-creds / github-creds / github-enterprise-creds | Secrets | Sample repository credential templates |
|
||||
| [`argocd-cmd-params-cm.yaml`](argocd-cmd-params-cm-yaml.md) | argocd-cmd-params-cm | ConfigMap | Argo CD env variables configuration |
|
||||
| [`argocd-secret.yaml`](argocd-secret-yaml.md) | argocd-secret | Secret | User Passwords, Certificates (deprecated), Signing Key, Dex secrets, Webhook secrets |
|
||||
| [`argocd-rbac-cm.yaml`](argocd-rbac-cm-yaml.md) | argocd-rbac-cm | ConfigMap | RBAC Configuration |
|
||||
| [`argocd-tls-certs-cm.yaml`](argocd-tls-certs-cm-yaml.md) | argocd-tls-certs-cm | ConfigMap | Custom TLS certificates for connecting Git repositories via HTTPS (v1.2 and later) |
|
||||
| [`argocd-ssh-known-hosts-cm.yaml`](argocd-ssh-known-hosts-cm-yaml.md) | argocd-ssh-known-hosts-cm | ConfigMap | SSH known hosts data for connecting Git repositories via SSH (v1.2 and later) |
|
||||
|
||||
For each specific kind of ConfigMap and Secret resource, there is only a single supported resource name (as listed in the above table) - if you need to merge things you need to do it before creating them.
|
||||
|
||||
|
|
@ -26,11 +26,11 @@ For each specific kind of ConfigMap and Secret resource, there is only a single
|
|||
|
||||
### Multiple configuration objects
|
||||
|
||||
| Sample File | Kind | Description |
|
||||
|-------------|------|-------------|
|
||||
| [`application.yaml`](application.yaml) | Application | Example application spec |
|
||||
| [`project.yaml`](project.yaml) | AppProject | Example project spec |
|
||||
| - | Secret | Repository credentials |
|
||||
| Sample File | Kind | Description |
|
||||
|------------------------------------------------------------------|-------------|--------------------------|
|
||||
| [`application.yaml`](../user-guide/application-specification.md) | Application | Example application spec |
|
||||
| [`project.yaml`](./project-specification.md) | AppProject | Example project spec |
|
||||
| - | Secret | Repository credentials |
|
||||
|
||||
For `Application` and `AppProject` resources, the name of the resource equals the name of the application or project within Argo CD. This also means that application and project names are unique within a given Argo CD installation - you cannot have the same application name for two different applications.
|
||||
|
||||
|
|
|
|||
7
docs/operator-manual/project-specification.md
Normal file
7
docs/operator-manual/project-specification.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Project Specification
|
||||
|
||||
The following describes all the available fields of a Project:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/project.yaml!}
|
||||
```
|
||||
7
docs/user-guide/application-specification.md
Normal file
7
docs/user-guide/application-specification.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Application Specification
|
||||
|
||||
The following describes all the available fields of an Application:
|
||||
|
||||
```yaml
|
||||
{!docs/operator-manual/application.yaml!}
|
||||
```
|
||||
|
|
@ -110,6 +110,7 @@ nav:
|
|||
- Application Pruning & Resource Deletion: operator-manual/applicationset/Application-Deletion.md
|
||||
- Progressive Syncs: operator-manual/applicationset/Progressive-Syncs.md
|
||||
- Git File Generator Globbing: operator-manual/applicationset/Generators-Git-File-Globbing.md
|
||||
- ApplicationSet Specification Reference: operator-manual/applicationset/applicationset-specification.md
|
||||
- Server Configuration Parameters:
|
||||
- operator-manual/server-commands/argocd-server.md
|
||||
- operator-manual/server-commands/argocd-application-controller.md
|
||||
|
|
@ -135,6 +136,7 @@ nav:
|
|||
- operator-manual/upgrading/1.2-1.3.md
|
||||
- operator-manual/upgrading/1.1-1.2.md
|
||||
- operator-manual/upgrading/1.0-1.1.md
|
||||
- Project Specification Reference: operator-manual/project-specification.md
|
||||
- User Guide:
|
||||
- user-guide/index.md
|
||||
- user-guide/application_sources.md
|
||||
|
|
@ -172,6 +174,7 @@ nav:
|
|||
- user-guide/extra_info.md
|
||||
- Notification subscriptions: user-guide/subscriptions.md
|
||||
- Command Reference: user-guide/commands/argocd.md
|
||||
- Application Specification Reference: user-guide/application-specification.md
|
||||
- Developer Guide:
|
||||
- developer-guide/index.md
|
||||
- Architecture:
|
||||
|
|
|
|||
Loading…
Reference in a new issue