argoproj
/
argo-helm
mirror of https://github.com/argoproj/argo-helm.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

docs(argo-workflows): update documentation links to readthedocs (#2472) 

argo-workflows docs moved from github pages to readthedocs

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Aikawa <yu.croco@gmail.com>
pull/2474/head argo-workflows-0.40.10
Jason Meridth 2024-02-02 18:44:56 -06:00 committed by GitHub
parent 865f452119
commit 186065e31f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -124,7 +124,7 @@ helm install charts/argo-workflows -n argo
argo version argo version
``` ```
Follow [these](https://argoproj.github.io/argo-workflows/quick-start/#submitting-an-example-workflow) instructions for running a hello world workflow. Follow [these](https://argo-workflows.readthedocs.io/en/stable/quick-start/#submitting-an-example-workflow) instructions for running a hello world workflow.
### Testing Argo CD Changes ### Testing Argo CD Changes

8
charts/argo-workflows/Chart.yaml
View File

@ -3,8 +3,8 @@ appVersion: v3.5.4
name: argo-workflows name: argo-workflows
description: A Helm chart for Argo Workflows description: A Helm chart for Argo Workflows
type: application type: application
version: 0.40.9 version: 0.40.10
icon: https://argoproj.github.io/argo-workflows/assets/logo.png icon: https://argo-workflows.readthedocs.io/en/stable/assets/logo.png
home: https://github.com/argoproj/argo-helm home: https://github.com/argoproj/argo-helm
sources: sources:
- https://github.com/argoproj/argo-workflows - https://github.com/argoproj/argo-workflows
@ -16,5 +16,5 @@ annotations:
fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252 fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
url: https://argoproj.github.io/argo-helm/pgp_keys.asc url: https://argoproj.github.io/argo-helm/pgp_keys.asc
artifacthub.io/changes: | artifacthub.io/changes: |
- kind: added - kind: fixed
description: Add MySQL persistence support explicitly on README description: Update argo-workflows documentation links to readthedocs

10
charts/argo-workflows/README.md
View File

@ -78,7 +78,7 @@ For full list of changes, please check ArtifactHub [changelog].
### High Availability ### High Availability
This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point. This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point.
Please see the upstream [Operator Manual's High Availability page](https://argoproj.github.io/argo-workflows/high-availability/) to understand how to scale Argo Workflows in depth. Please see the upstream [Operator Manual's High Availability page](https://argo-workflows.readthedocs.io/en/stable/high-availability/) to understand how to scale Argo Workflows in depth.
### Workflow controller ### Workflow controller
@ -354,7 +354,7 @@ Fields to note:
| artifactRepository.azure | object | `{}` (See [values.yaml]) | Store artifact in Azure Blob Storage | | artifactRepository.azure | object | `{}` (See [values.yaml]) | Store artifact in Azure Blob Storage |
| artifactRepository.gcs | object | `{}` (See [values.yaml]) | Store artifact in a GCS object store | | artifactRepository.gcs | object | `{}` (See [values.yaml]) | Store artifact in a GCS object store |
| artifactRepository.s3 | object | See [values.yaml] | Store artifact in a S3-compliant object store | | artifactRepository.s3 | object | See [values.yaml] | Store artifact in a S3-compliant object store |
| artifactRepositoryRef | object | `{}` (See [values.yaml]) | The section of [artifact repository ref](https://argoproj.github.io/argo-workflows/artifact-repository-ref/). Each map key is the name of configmap | | artifactRepositoryRef | object | `{}` (See [values.yaml]) | The section of [artifact repository ref](https://argo-workflows.readthedocs.io/en/stable/artifact-repository-ref/). Each map key is the name of configmap |
| customArtifactRepository | object | `{}` | The section of custom artifact repository. Utilize a custom artifact repository that is not one of the current base ones (s3, gcs, azure) | | customArtifactRepository | object | `{}` | The section of custom artifact repository. Utilize a custom artifact repository that is not one of the current base ones (s3, gcs, azure) |
| useStaticCredentials | bool | `true` | Use static credentials for S3 (eg. when not using AWS IRSA) | | useStaticCredentials | bool | `true` | Use static credentials for S3 (eg. when not using AWS IRSA) |
@ -381,7 +381,7 @@ Fields to note:
[affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ [affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
[BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom [BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom
[FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters [FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters
[links]: https://argoproj.github.io/argo-workflows/links/ [links]: https://argo-workflows.readthedocs.io/en/stable/links/
[columns]: https://github.com/argoproj/argo-workflows/pull/10693 [columns]: https://github.com/argoproj/argo-workflows/pull/10693
[Node selector]: https://kubernetes.io/docs/user-guide/node-selection/ [Node selector]: https://kubernetes.io/docs/user-guide/node-selection/
[Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ [Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
@ -390,5 +390,5 @@ Fields to note:
[TopologySpreadConstraints]: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ [TopologySpreadConstraints]: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
[values.yaml]: values.yaml [values.yaml]: values.yaml
[changelog]: https://artifacthub.io/packages/helm/argo/argo-workflows?modal=changelog [changelog]: https://artifacthub.io/packages/helm/argo/argo-workflows?modal=changelog
[SSO RBAC]: https://argo-workflows.readthedocs.io/en/latest/argo-server-sso/ [SSO RBAC]: https://argo-workflows.readthedocs.io/en/stable/argo-server-sso/
[Argo Server Auth Mode]: https://argo-workflows.readthedocs.io/en/latest/argo-server-auth-mode/ [Argo Server Auth Mode]: https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/

8
charts/argo-workflows/README.md.gotmpl
View File

@ -78,7 +78,7 @@ For full list of changes, please check ArtifactHub [changelog].
### High Availability ### High Availability
This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point. This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point.
Please see the upstream [Operator Manual's High Availability page](https://argoproj.github.io/argo-workflows/high-availability/) to understand how to scale Argo Workflows in depth. Please see the upstream [Operator Manual's High Availability page](https://argo-workflows.readthedocs.io/en/stable/high-availability/) to understand how to scale Argo Workflows in depth.
### Workflow controller ### Workflow controller
@ -199,7 +199,7 @@ Fields to note:
[affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ [affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
[BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom [BackendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/concepts/backendconfig#backendconfigspec_v1beta1_cloudgooglecom
[FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters [FrontendConfigSpec]: https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-features#configuring_ingress_features_through_frontendconfig_parameters
[links]: https://argoproj.github.io/argo-workflows/links/ [links]: https://argo-workflows.readthedocs.io/en/stable/links/
[columns]: https://github.com/argoproj/argo-workflows/pull/10693 [columns]: https://github.com/argoproj/argo-workflows/pull/10693
[Node selector]: https://kubernetes.io/docs/user-guide/node-selection/ [Node selector]: https://kubernetes.io/docs/user-guide/node-selection/
[Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ [Pod Disruption Budget]: https://kubernetes.io/docs/tasks/run-application/configure-pdb/
@ -208,5 +208,5 @@ Fields to note:
[TopologySpreadConstraints]: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ [TopologySpreadConstraints]: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/
[values.yaml]: values.yaml [values.yaml]: values.yaml
[changelog]: https://artifacthub.io/packages/helm/argo/argo-workflows?modal=changelog [changelog]: https://artifacthub.io/packages/helm/argo/argo-workflows?modal=changelog
[SSO RBAC]: https://argo-workflows.readthedocs.io/en/latest/argo-server-sso/ [SSO RBAC]: https://argo-workflows.readthedocs.io/en/stable/argo-server-sso/
[Argo Server Auth Mode]: https://argo-workflows.readthedocs.io/en/latest/argo-server-auth-mode/ [Argo Server Auth Mode]: https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/

4
charts/argo-workflows/ci/ha-values.yaml
View File

@ -1,7 +1,7 @@
# Sample values for High Availability configuration, following https://argoproj.github.io/argo-workflows/high-availability/ # Sample values for High Availability configuration, following https://argo-workflows.readthedocs.io/en/stable/high-availability/
controller: controller:
# in v3.0+, a second controller can be ran as a hot-standby: https://argoproj.github.io/argo-workflows/high-availability/#workflow-controller # in v3.0+, a second controller can be ran as a hot-standby: https://argo-workflows.readthedocs.io/en/stable/high-availability/#workflow-controller
replicas: 2 # should be strictly greater than PDB minAvailable replicas: 2 # should be strictly greater than PDB minAvailable
# enable PDB with at least one Pod # enable PDB with at least one Pod
pdb: pdb:

18
charts/argo-workflows/values.yaml
View File

@ -147,7 +147,7 @@ controller:
drop: drop:
- ALL - ALL
# -- enable Workflow Archive to store the status of workflows. Postgres and MySQL (>= 5.7.8) are available. # -- enable Workflow Archive to store the status of workflows. Postgres and MySQL (>= 5.7.8) are available.
## Ref: https://argo-workflows.readthedocs.io/en/latest/workflow-archive/ ## Ref: https://argo-workflows.readthedocs.io/en/stable/workflow-archive/
persistence: {} persistence: {}
# connectionPool: # connectionPool:
# maxIdleConns: 100 # maxIdleConns: 100
@ -186,12 +186,12 @@ controller:
# -- Default values that will apply to all Workflows from this controller, unless overridden on the Workflow-level. # -- Default values that will apply to all Workflows from this controller, unless overridden on the Workflow-level.
# Only valid for 2.7+ # Only valid for 2.7+
## See more: https://argoproj.github.io/argo-workflows/default-workflow-specs/ ## See more: https://argo-workflows.readthedocs.io/en/stable/default-workflow-specs/
workflowDefaults: {} workflowDefaults: {}
# spec: # spec:
# ttlStrategy: # ttlStrategy:
# secondsAfterCompletion: 84600 # secondsAfterCompletion: 84600
# # Ref: https://argoproj.github.io/argo-workflows/artifact-repository-ref/ # # Ref: https://argo-workflows.readthedocs.io/en/stable/artifact-repository-ref/
# artifactRepositoryRef: # artifactRepositoryRef:
# configMap: my-artifact-repository # default is "artifact-repositories" # configMap: my-artifact-repository # default is "artifact-repositories"
# key: v2-s3-artifact-repository # default can be set by the `workflows.argoproj.io/default-artifact-repository` annotation in config map. # key: v2-s3-artifact-repository # default can be set by the `workflows.argoproj.io/default-artifact-repository` annotation in config map.
@ -343,7 +343,7 @@ controller:
priorityClassName: "" priorityClassName: ""
# -- Configure Argo Server to show custom [links] # -- Configure Argo Server to show custom [links]
## Ref: https://argoproj.github.io/argo-workflows/links/ ## Ref: https://argo-workflows.readthedocs.io/en/stable/links/
links: [] links: []
# -- Configure Argo Server to show custom [columns] # -- Configure Argo Server to show custom [columns]
## Ref: https://github.com/argoproj/argo-workflows/pull/10693 ## Ref: https://github.com/argoproj/argo-workflows/pull/10693
@ -556,7 +556,7 @@ server:
# -- Run the argo server in "secure" mode. Configure this value instead of `--secure` in extraArgs. # -- Run the argo server in "secure" mode. Configure this value instead of `--secure` in extraArgs.
## See the following documentation for more details on secure mode: ## See the following documentation for more details on secure mode:
## https://argoproj.github.io/argo-workflows/tls/ ## https://argo-workflows.readthedocs.io/en/stable/tls/
secure: false secure: false
# -- Extra environment variables to provide to the argo-server container # -- Extra environment variables to provide to the argo-server container
@ -568,11 +568,11 @@ server:
authMode: "" authMode: ""
# -- A list of supported authentication modes. Available values are `server`, `client`, or `sso`. If you provide sso, please configure `.Values.server.sso` as well. # -- A list of supported authentication modes. Available values are `server`, `client`, or `sso`. If you provide sso, please configure `.Values.server.sso` as well.
## Ref: https://argoproj.github.io/argo-workflows/argo-server-auth-mode/ ## Ref: https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/
authModes: [] authModes: []
# -- Extra arguments to provide to the Argo server binary. # -- Extra arguments to provide to the Argo server binary.
## Ref: https://argoproj.github.io/argo-workflows/argo-server/#options ## Ref: https://argo-workflows.readthedocs.io/en/stable/argo-server/#options
extraArgs: [] extraArgs: []
logging: logging:
@ -829,7 +829,7 @@ customArtifactRepository: {}
# name: artifactory-creds # name: artifactory-creds
# key: password # key: password
# -- The section of [artifact repository ref](https://argoproj.github.io/argo-workflows/artifact-repository-ref/). # -- The section of [artifact repository ref](https://argo-workflows.readthedocs.io/en/stable/artifact-repository-ref/).
# Each map key is the name of configmap # Each map key is the name of configmap
# @default -- `{}` (See [values.yaml]) # @default -- `{}` (See [values.yaml])
artifactRepositoryRef: {} artifactRepositoryRef: {}
@ -884,7 +884,7 @@ artifactRepositoryRef: {}
emissary: emissary:
# -- The command/args for each image on workflow, needed when the command is not specified and the emissary executor is used. # -- The command/args for each image on workflow, needed when the command is not specified and the emissary executor is used.
## See more: https://argoproj.github.io/argo-workflows/workflow-executors/#emissary-emissary ## See more: https://argo-workflows.readthedocs.io/en/stable/workflow-executors/#emissary-emissary
images: [] images: []
# argoproj/argosay:v2: # argoproj/argosay:v2:
# cmd: [/argosay] # cmd: [/argosay]