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.

Sign up for GitHub

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

Jump to bottom

docs: rewrap comments in code blocks to not overflow on desktop #17837

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+512 −283
Open

docs: rewrap comments in code blocks to not overflow on desktop #17837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/developer-guide/debugging-remote-environment.md
View file
Open in desktop
Expand Up @@ -22,8 +22,11 @@ Connect to one of the services, for example, to debug the main ArgoCD server run
```shell
kubectl config set-context --current --namespace argocd
telepresence helm install # Installs telepresence into your cluster
telepresence connect # Starts the connection to your cluster (bound to the current namespace)
telepresence intercept argocd-server --port 8080:http --env-file .envrc.remote # Starts the interception
telepresence connect # Starts the connection to your cluster (bound to the
# current namespace)
telepresence intercept argocd-server \
--port 8080:http \
--env-file .envrc.remote # Starts the interception
```
* `--port` forwards traffic of remote port http to 8080 locally (use `--port 8080:https` if argocd-server terminates TLS)
* `--env-file` writes all the environment variables of the remote pod into a local file, the variables are also set on the subprocess of the `--run` command
Expand Down
7 changes: 4 additions & 3 deletions docs/developer-guide/running-locally.md
View file
Open in desktop
Expand Up @@ -75,8 +75,8 @@ The `make start` command of the virtualized toolchain runs the build and program
Docker should be installed already. Assuming you manage installed software using [Homebrew](https://brew.sh/), you can install other prerequisites like this:

```sh
# goreman is used to start all needed processes to get a working Argo CD development
# environment (defined in `Procfile`)
# goreman is used to start all needed processes to get a working Argo CD
# development environment (defined in `Procfile`)
brew install goreman

# You can use `kind` to run Kubernetes inside Docker. But pointing to any other
Expand Down Expand Up @@ -151,7 +151,8 @@ export ARGOCD_OPTS="--plaintext --insecure"
After making a code change, ensure to rebuild and restart the respective service:

```sh
# Example for working on the repo server Go code, see other service names in `Procfile`
# Example for working on the repo server Go code, see other service names in
# `Procfile`
goreman run restart repo-server
```

Expand Down
152 changes: 104 additions & 48 deletions docs/operator-manual/application.yaml
View file
Open in desktop
Expand Up @@ -19,15 +19,23 @@ spec:

# Source of the application manifests
source:
repoURL: https://github.com/argoproj/argocd-example-apps.git # Can point to either a Helm chart repo or a git repo.
repoURL: https://github.com/argoproj/argocd-example-apps.git # Can point to
# either a
# Helm chart
# repo or a
# git repo.
targetRevision: HEAD # For Helm, this refers to the chart version.
path: guestbook # This has no meaning for Helm charts pulled directly from a Helm repo instead of git.
path: guestbook # This has no meaning for Helm charts pulled directly from
# a Helm repo instead of git.

# helm specific config
chart: chart-name # Set this when pulling directly from a Helm repo. DO NOT set for git-hosted Helm charts.
chart: chart-name # Set this when pulling directly from a Helm repo. DO NOT
# set for git-hosted Helm charts.
helm:
passCredentials: false # If true then adds --pass-credentials to Helm commands to pass credentials to all domains
# Extra parameters to set (same as setting through values.yaml, but these take precedence)
passCredentials: false # If true then adds --pass-credentials to Helm
# commands to pass credentials to all domains
# Extra parameters to set (same as setting through values.yaml, but these
# take precedence)
parameters:
- name: "nginx-ingress.controller.service.annotations.external-dns\\.alpha\\.kubernetes\\.io/hostname"
value: mydomain.example.com
Expand All @@ -48,10 +56,12 @@ spec:
valueFiles:
- values-prod.yaml

# Ignore locally missing valueFiles when installing Helm chart. Defaults to false
# Ignore locally missing valueFiles when installing Helm chart. Defaults
# to false
ignoreMissingValueFiles: false

# Values file as block file. Prefer to use valuesObject if possible (see below)
# Values file as block file. Prefer to use valuesObject if possible (see
# below)
values: |
ingress:
enabled: true
Expand Down Expand Up @@ -83,25 +93,30 @@ spec:
hosts:
- mydomain.example.com

# Skip custom resource definition installation if chart contains custom resource definitions. Defaults to false
# Skip custom resource definition installation if chart contains custom
# resource definitions. Defaults to false
skipCrds: false

# Optional Helm version to template with. If omitted it will fall back to look at the 'apiVersion' in Chart.yaml
# and decide which Helm binary to use automatically. This field can be either 'v2' or 'v3'.
# Optional Helm version to template with. If omitted it will fall back to
# look at the 'apiVersion' in Chart.yaml and decide which Helm binary to
# use automatically. This field can be either 'v2' or 'v3'.
version: v2

# kustomize specific config
kustomize:
# Optional kustomize version. Note: version must be configured in argocd-cm ConfigMap
# Optional kustomize version. Note: version must be configured in
# argocd-cm ConfigMap
version: v3.5.4
# Supported kustomize transformers. https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/
# Supported kustomize transformers.
# https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/
namePrefix: prod-
nameSuffix: -some-suffix
commonLabels:
foo: bar
commonAnnotations:
beep: boop-${ARGOCD_APP_REVISION}
# Toggle which enables/disables env variables substitution in commonAnnotations
# Toggle which enables/disables env variables substitution in
# commonAnnotations
commonAnnotationsEnvsubst: true
images:
- gcr.io/heptio-images/ks-guestbook-demo:0.2
Expand All @@ -119,7 +134,8 @@ spec:
extVars:
- name: foo
value: bar
# You can use "code" to determine if the value is either string (false, the default) or Jsonnet code (if code is true).
# You can use "code" to determine if the value is either string
# (false, the default) or Jsonnet code (if code is true).
- code: true
name: baz
value: "true"
Expand All @@ -128,19 +144,26 @@ spec:
- code: false
name: foo
value: bar
# Exclude contains a glob pattern to match paths against that should be explicitly excluded from being used during
# manifest generation. This takes precedence over the `include` field.
# To match multiple patterns, wrap the patterns in {} and separate them with commas. For example: '{config.yaml,env-use2/*}'
# Exclude contains a glob pattern to match paths against that should be
# explicitly excluded from being used during manifest generation. This
# takes precedence over the `include` field.
# To match multiple patterns, wrap the patterns in {} and separate them
# with commas.
# For example: '{config.yaml,env-use2/*}'
exclude: 'config.yaml'
# Include contains a glob pattern to match paths against that should be explicitly included during manifest
# generation. If this field is set, only matching manifests will be included.
# To match multiple patterns, wrap the patterns in {} and separate them with commas. For example: '{*.yml,*.yaml}'
# Include contains a glob pattern to match paths against that should be
# explicitly included during manifest generation. If this field is set,
# only matching manifests will be included.
# To match multiple patterns, wrap the patterns in {} and separate them
# with commas.
# For example: '{*.yml,*.yaml}'
include: '*.yaml'

# plugin specific config
plugin:
# If the plugin is defined as a sidecar and name is not passed, the plugin will be automatically matched with the
# Application according to the plugin's discovery rules.
# If the plugin is defined as a sidecar and name is not passed, the plugin
# will be automatically matched with the Application according to the
# plugin's discovery rules.
name: mypluginname
# environment variables passed to the plugin
env:
Expand All @@ -158,18 +181,27 @@ spec:

# Sources field specifies the list of sources for the application
sources:
- repoURL: https://github.com/argoproj/argocd-example-apps.git # Can point to either a Helm chart repo or a git repo.
- repoURL: https://github.com/argoproj/argocd-example-apps.git # Can point
# to either
# a Helm
# chart repo
# or a git
# repo.
targetRevision: HEAD # For Helm, this refers to the chart version.
path: guestbook # This has no meaning for Helm charts pulled directly from a Helm repo instead of git.
ref: my-repo # For Helm, acts as a reference to this source for fetching values files from this source. Has no meaning when under `source` field
path: guestbook # This has no meaning for Helm charts pulled directly
# from a Helm repo instead of git.
ref: my-repo # For Helm, acts as a reference to this source for fetching
# values files from this source. Has no meaning when under
# `source` field

# Destination cluster and namespace to deploy the application
destination:
# cluster API URL
server: https://kubernetes.default.svc
# or cluster name
# name: in-cluster
# The namespace will only be set for namespace-scoped resources that have not set a value for .metadata.namespace
# The namespace will only be set for namespace-scoped resources that have
# not set a value for .metadata.namespace
namespace: guestbook

# Extra information to show in the Argo CD Application details tab
Expand All @@ -179,18 +211,34 @@ spec:

# Sync policy
syncPolicy:
automated: # automated sync by default retries failed attempts 5 times with following delays between attempts ( 5s, 10s, 20s, 40s, 80s ); retry controlled using `retry` field.
prune: true # Specifies if resources should be pruned during auto-syncing ( false by default ).
selfHeal: true # Specifies if partial app sync should be executed when resources are changed only in target Kubernetes cluster and no git change detected ( false by default ).
allowEmpty: false # Allows deleting all application resources during automatic syncing ( false by default ).
automated: # automated sync by default retries failed attempts 5 times with
# following delays between attempts ( 5s, 10s, 20s, 40s, 80s );
# retry controlled using `retry` field.
prune: true # Specifies if resources should be pruned during auto-syncing
# ( false by default ).
selfHeal: true # Specifies if partial app sync should be executed when
# resources are changed only in target Kubernetes cluster
# and no git change detected ( false by default ).
allowEmpty: false # Allows deleting all application resources during
# automatic syncing ( false by default ).
syncOptions: # Sync options which modifies sync behavior
- Validate=false # disables resource validation (equivalent to 'kubectl apply --validate=false') ( true by default ).
- CreateNamespace=true # Namespace Auto-Creation ensures that namespace specified as the application destination exists in the destination cluster.
- PrunePropagationPolicy=foreground # Supported policies are background, foreground and orphan.
- PruneLast=true # Allow the ability for resource pruning to happen as a final, implicit wave of a sync operation
- RespectIgnoreDifferences=true # When syncing changes, respect fields ignored by the ignoreDifferences configuration
- ApplyOutOfSyncOnly=true # Only sync out-of-sync resources, rather than applying every object in the application
managedNamespaceMetadata: # Sets the metadata for the application namespace. Only valid if CreateNamespace=true (see above), otherwise it's a no-op.
- Validate=false # disables resource validation (equivalent to 'kubectl
# apply --validate=false') ( true by default ).
- CreateNamespace=true # Namespace Auto-Creation ensures that namespace
# specified as the application destination exists in
# the destination cluster.
- PrunePropagationPolicy=foreground # Supported policies are background,
# foreground and orphan.
- PruneLast=true # Allow the ability for resource pruning to happen as a
# final, implicit wave of a sync operation
- RespectIgnoreDifferences=true # When syncing changes, respect fields
# ignored by the ignoreDifferences
# configuration
- ApplyOutOfSyncOnly=true # Only sync out-of-sync resources, rather than
# applying every object in the application
managedNamespaceMetadata: # Sets the metadata for the application namespace.
# Only valid if CreateNamespace=true (see above),
# otherwise it's a no-op.
labels: # The labels to set on the application namespace
any: label
you: like
Expand All @@ -201,14 +249,19 @@ spec:

# The retry feature is available since v1.7
retry:
limit: 5 # number of failed sync attempt retries; unlimited number of attempts if less than 0
limit: 5 # number of failed sync attempt retries; unlimited number of
# attempts if less than 0
backoff:
duration: 5s # the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")
factor: 2 # a factor to multiply the base duration after each failed retry
maxDuration: 3m # the maximum amount of time allowed for the backoff strategy
duration: 5s # the amount to back off. Default unit is seconds, but
# could also be a duration (e.g. "2m", "1h")
factor: 2 # a factor to multiply the base duration after each failed
# retry
maxDuration: 3m # the maximum amount of time allowed for the backoff
# strategy

# Will ignore differences between live and desired states during the diff. Note that these configurations are not
# used during the sync process unless the `RespectIgnoreDifferences=true` sync option is enabled.
# Will ignore differences between live and desired states during the diff.
# Note that these configurations are not used during the sync process unless
# the `RespectIgnoreDifferences=true` sync option is enabled.
ignoreDifferences:
# for the specified json pointers
- group: apps
Expand All @@ -223,12 +276,15 @@ spec:
kind: "*"
managedFieldsManagers:
- kube-controller-manager
# Name and namespace are optional. If specified, they must match exactly, these are not glob patterns.
# Name and namespace are optional. If specified, they must match exactly,
# these are not glob patterns.
name: my-deployment
namespace: my-namespace

# RevisionHistoryLimit limits the number of items kept in the application's revision history, which is used for
# informational purposes as well as for rollbacks to previous versions. This should only be changed in exceptional
# circumstances. Setting to zero will store no history. This will reduce storage used. Increasing will increase the
# space used to store the history, so we do not recommend increasing it.
# RevisionHistoryLimit limits the number of items kept in the application's
# revision history, which is used for informational purposes as well as for
# rollbacks to previous versions. This should only be changed in exceptional
# circumstances. Setting to zero will store no history. This will reduce
# storage used. Increasing will increase the space used to store the history,
# so we do not recommend increasing it.
revisionHistoryLimit: 10