Elgato_dark/argo-cd
1
0
Fork 0
mirror of https://github.com/argoproj/argo-cd synced 2026-04-21 17:07:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 22
argo-cd/mkdocs.yml

116 lines
3.9 KiB
YAML
Raw Normal View History

Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
site_name: Argo CD - Declarative GitOps CD for Kubernetes
Fix github reference to use mainline instead of fork (#1445)
2019-04-12 01:32:12 +00:00
repo_url: https://github.com/argoproj/argo-cd
Fixes doc bugs. Closes #1395 (#1403)
2019-04-09 18:01:04 +00:00
strict: true
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
theme:
name: material
palette:
primary: teal
font:
text: 'Work Sans'
logo: 'assets/logo.png'
refactor: change favicon.png on docs to argo-cd logo (#3723) Signed-off-by: darshanime <deathbullet@gmail.com>
2020-06-08 08:28:39 +00:00
favicon: 'assets/favicon.png'
fix: Capitalization in toc (#5024) Signed-off-by: Regina Scott <rescott@redhat.com>
2020-12-10 21:33:01 +00:00
language: en-custom
custom_dir: overrides
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
google_analytics:
- 'UA-105170809-2'
- 'auto'
markdown_extensions:
- codehilite
- admonition
- toc:
permalink: true
nav:
- Overview: index.md
- understand_the_basics.md
Docs (#1441)
2019-04-15 20:39:04 +00:00
- core_concepts.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- getting_started.md
- Operator Manual:
- operator-manual/index.md
- operator-manual/architecture.md
- operator-manual/declarative-setup.md
- operator-manual/ingress.md
feat: implement Service Account / Local Users (#3215) * feat: implement Service Account / Local Users * add local users documentation * implement accounts management UI * address code review notes
2020-03-17 22:31:37 +00:00
- User Management:
- operator-manual/user-management/index.md
- operator-manual/user-management/auth0.md
- operator-manual/user-management/microsoft.md
- operator-manual/user-management/okta.md
- operator-manual/user-management/onelogin.md
docs: Add documentation for Keycloak SSO integration (#3767) docs: Add documentation for Keycloak SSO integration (#3767)
2020-06-16 19:35:58 +00:00
- operator-manual/user-management/keycloak.md
docs: added docs for openunison integration (#4146) * added docs for openunison integration * fixed formatting * added link to makedocs, fix last header
2020-08-24 17:28:51 +00:00
- operator-manual/user-management/openunison.md
docs: add Google SAML integration example (#4816) Signed-off-by: Seth Pellegrino <seth@verica.io>
2020-11-12 22:18:48 +00:00
- operator-manual/user-management/google.md
Added SSO and RBAC (#2503)
2019-10-17 02:58:42 +00:00
- operator-manual/rbac.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- operator-manual/security.md
Documents cluster bootstrapping. Close #1481 (#1530)
2019-04-29 18:35:57 +00:00
- operator-manual/cluster-bootstrapping.md
Adds doc on secrets, updates changelog, updates Github templates (#2550)
2019-10-23 22:16:26 +00:00
- operator-manual/secret-management.md
Documents HA/DR (#1690)
2019-06-05 21:23:30 +00:00
- operator-manual/high_availability.md
- operator-manual/disaster_recovery.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- operator-manual/webhook.md
- operator-manual/health.md
- operator-manual/custom_tools.md
docs: add 1.7 changelog and update instructions (#4095) * docs: add 1.7 changelog and update instructions * apply reviewer notes
2020-08-14 19:47:50 +00:00
- operator-manual/custom-styles.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- operator-manual/metrics.md
docs: add notifications.md with recommandation about notifications (#2979) * docs: add demo argocd/grafana links * docs: add notifications.md with recommandation about notifications
2020-01-15 18:48:03 +00:00
- operator-manual/notifications.md
feat: add settings troubleshooting commands to the 'argocd-util' binary (#3398) * feat: add settings troubleshooting commands to the 'argocd-util' binary
2020-04-14 14:51:16 +00:00
- operator-manual/troubleshooting.md
docs: Generate server command reference (#4795) * Generate server command reference docs Signed-off-by: William Tam <email.wtam@gmail.com> * Insert newline Signed-off-by: William Tam <email.wtam@gmail.com> * undo iinsert newline Signed-off-by: William Tam <email.wtam@gmail.com> Signed-off-by: William Tam <email.wtam@gmail.com> * * Renane tab to `Server Configuration Parameters` * Generate argocd-util command docs Signed-off-by: William Tam <email.wtam@gmail.com> * Tweak erver command descriptions Signed-off-by: William Tam <email.wtam@gmail.com> * Minor tweaks to argocd-util command descriptions Signed-off-by: William Tam <email.wtam@gmail.com> * Move main_test.go to secrets_redactor_test.go into commands package Signed-off-by: William Tam <email.wtam@gmail.com> * Disable auto generation tag. Signed-off-by: William Tam <email.wtam@gmail.com>
2020-11-10 19:01:11 +00:00
- Server Configuration Parameters:
- operator-manual/server-commands/argocd-server.md
- operator-manual/server-commands/argocd-application-controller.md
- operator-manual/server-commands/argocd-repo-server.md
- argocd-util Tools: operator-manual/server-commands/argocd-util.md
docs: describe upgrading process and version breaking changes (#3512) * docs: describe upgrading process and version breaking changes * add upgrading instructions link to overview doc
2020-04-30 19:28:39 +00:00
- Upgrading:
- operator-manual/upgrading/overview.md
fix: prevent short-circuit during env variable substitution (#4984) * fix: prevent short-circuit during env variable substitution Signed-off-by: Alexander Matyushentsev <AMatyushentsev@gmail.com> * improve expansion logic Signed-off-by: Alexander Matyushentsev <AMatyushentsev@gmail.com>
2020-12-07 19:22:14 +00:00
- operator-manual/upgrading/1.7-1.8.md
docs: add 1.7 changelog and update instructions (#4095) * docs: add 1.7 changelog and update instructions * apply reviewer notes
2020-08-14 19:47:50 +00:00
- operator-manual/upgrading/1.6-1.7.md
docs: add 1.5 - 1.6 upgrade instructions (#3790)
2020-06-17 18:28:41 +00:00
- operator-manual/upgrading/1.5-1.6.md
docs: describe upgrading process and version breaking changes (#3512) * docs: describe upgrading process and version breaking changes * add upgrading instructions link to overview doc
2020-04-30 19:28:39 +00:00
- operator-manual/upgrading/1.4-1.5.md
- operator-manual/upgrading/1.3-1.4.md
- operator-manual/upgrading/1.2-1.3.md
- operator-manual/upgrading/1.1-1.2.md
docs: fix invalid link in declarative-setup.md (#3813)
2020-06-19 16:33:42 +00:00
- operator-manual/upgrading/1.0-1.1.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- User Guide:
- user-guide/index.md
- user-guide/application_sources.md
Documents Kustomize. Closes #1566 (#1572)
2019-05-08 16:37:45 +00:00
- user-guide/kustomize.md
- user-guide/helm.md
- user-guide/ksonnet.md
Adds support for ARGO_CD_[TARGET_REVISION|REVISION] and pass to Custom Tool/Helm/Jsonnet (#2415)
2019-10-21 23:54:23 +00:00
- user-guide/jsonnet.md
Documents Kustomize. Closes #1566 (#1572)
2019-05-08 16:37:45 +00:00
- user-guide/config-management-plugins.md
- user-guide/tool_detection.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/projects.md
Issue #1411 - Document private repository configuration (#1515)
2019-04-24 17:26:07 +00:00
- user-guide/private-repositories.md
feat: GPG commit signature verification (#2492) (#3242) * Add initial primitives and tests for GPG related operations * More tests and test documentation * Move gpg primitives to own module * Add initial primitives for running git verify-commit and tests * Improve and better comment test * Implement VerifyCommitSignature() primitive for metrics wrapper * More commentary * Make reposerver verify gpg signatures when generating manifests * Make signature validation optional * Forbid use of local manifests when signature verification is enabled * Introduce new signatureKeys field in project CRD * Initial support for only syncing against signed revisions * Updates to GnuPG primitives and more test cases * Move signature verification to correct place and add tests * Add signature verification result to revision metadata and display it in UI * Add more primitives and move out some stuff to common module * Add more testdata * Add key management primitives to ArgoDB * Move type GnuPGPublicKey to appsv1 package * Add const ArgoCDGPGKeysConfigMapName * Handle key operations with appsv1.GnuPGPublicKey * Add initial API for managing GPG keys * Remove deprecated code * Add primitives for adding public keys to configuration * Change semantics of ValidateGPGKeys to return more key information * Add key import functionality to public key API * Fix code quirks reported by linter * More code quirks fixes * Fix test * Add primitives for deleting keys from configuration * Add delete key operation to API and CLI * Cosmetics * Implement logic to sync configuration to keyring in repo-server * Add IsGPGEnabled() primitive and also update trustdb on ownertrust changes * Use gpg.IsGPGEnabled() instead of custom test * Remove all keyring manipulating methods from DB * Cosmetics/comments * Require grpc methods from argoproj pkg * Enable setting config path via ARGOCD_GPG_DATA_PATH * Allow "no" and any cases in ARGOCD_GPG_ENABLED * Enable GPG feature on start and start-e2e and set required environment * Cosmetics/comments * Cosmetics and commentary * Update API documentation * Fix comment * Only run GPG related operations if GPG is enabled * Allow setting ARGOCD_GPG_ENABLE from the environment * Create GPG ConfigMap resource during installation * Use function instead of constant to get the watcher path * Re-watch source path in case it gets recreated. Also, error on finish * Add End-to-End tests for GPG commit verification * Introduce SignatureKey type for AppProject CRD * Fix merge error from previous commit * Adapt test for additional manifest (argocd-gpg-keys-cm.yaml) * Fix linter issues * Adapt CircleCI configuration to enable running tests * Add wrapper scripts for git and gpg * Sigh. * Display gpg version in CircleCI * Install gnupg2 and link it to gpg in CI * Try to install gnupg2 in CircleCI image * More CircleCI tweaks * # This is a combination of 10 commits. # This is the 1st commit message: Containerize tests - test cycle # This is the commit message #2: adapt working directory # This is the commit message #3: Build before running tests (so we might have a cache) # This is the commit message #4: Test limiting parallelism # This is the commit message #5: Remove unbound variable # This is the commit message #6: Decrease parallelism to find out limit # This is the commit message #7: Use correct flag # This is the commit message #8: Update Docker image # This is the commit message #9: Remove build phase and increase parallelism # This is the commit message #10: Further increase parallelism * Dockerize toolchain * Add new targets to Makefile * Codegen * Properly handle permissions for E2E tests * Remove gnupg2 installation from CircleCI configuration * Limit parallelism of build * Fix Yarn lint * Retrigger CI for possible flaky test * Codegen * Remove duplicate target in Makefile * Pull in pager from dep ensure -v * Adapt to gitops-engine changes and codegen * Use new health package for health status constants * Add GPG methods to ArgoDB mock module * Fix possible nil pointer dereference * Fix linter issue in imports * Introduce RBAC resource type 'gpgkeys' and adapt policies * Use ARGOCD_GNUPGHOME instead of GNUPGHOME for subsystem configuration Also remove some deprecated unit tests. * Also register GPG keys API with gRPC-GW * Update from codegen * Update GPG key API * Add web UI to manage GPG keys * Lint updates * Change wording * Add some plausibility checks for supplied data on key creation * Update from codegen * Re-allow binary keys and move check for ASCII armoured to UI * Make yarn lint happy * Add editing signature keys for projects in UI * Add ability to configure signature keys for project in CLI * Change default value to use for GNUPGHOME * Do not include data section in default gpg keys CM * Adapt Docker image for GnuPG feature * Add required configuration to installation manifests * Add add-signature-key and remove-signature-key commands to project CLI * Fix typo * Add initial user documentation for GnuPG verification * Fix role name - oops * Mention required RBAC roles in docs * Support GPG verification of git annotated tags as well * Ensure CLI can build succesfully * Better support verification on tags * Print key type in upper case * Update user documentation * Correctly disable GnuPG verification if ARGOCD_GPG_ENABLE=false * Clarify that this feature is only available with Git repositories * codegen * Move verification code to own function * Remove deprecated check * Make things more developer friendly when running locally * Enable GPG feature by default, and don't require ARGOCD_GNUPGHOME to be set * Revert changes to manifests to reflect default enable state * Codegen
2020-06-22 16:21:53 +00:00
- GnuPG verification: user-guide/gpg-verification.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/auto_sync.md
- user-guide/diffing.md
Issue #1167 - Document orphaned resources, update proj CLI (#2188)
2019-08-22 18:35:43 +00:00
- user-guide/orphaned-resources.md
Adds Prune=false and IgnoreExtraneous options (#1680)
2019-06-07 15:46:11 +00:00
- user-guide/compare-options.md
- user-guide/sync-options.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/parameters.md
Adds support for ARGO_CD_[TARGET_REVISION|REVISION] and pass to Custom Tool/Helm/Jsonnet (#2415)
2019-10-21 23:54:23 +00:00
- user-guide/build-environment.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/tracking_strategies.md
- user-guide/resource_hooks.md
Sync wave (#1634)
2019-06-05 01:17:41 +00:00
- user-guide/selective_sync.md
- user-guide/sync-waves.md
Convert maintenance windows to sync windows (#2416) Convert maintenance windows to sync windows (#2416)
2019-10-08 22:20:19 +00:00
- user-guide/sync_windows.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/ci_automation.md
Adds docs about app deletion (#1664)
2019-05-30 21:38:52 +00:00
- user-guide/app_deletion.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- user-guide/best_practices.md
Badgedocs (#1840)
2019-06-28 17:45:46 +00:00
- user-guide/status-badge.md
docs: Add generated argocd command docs (#4606)
2020-10-20 00:30:32 +00:00
- Command Reference: user-guide/commands/argocd.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- Developer Guide:
- developer-guide/index.md
chore: Containerize complete build & test toolchain (#3245) chore: Containerize complete build & test toolchain
2020-03-27 18:36:20 +00:00
- developer-guide/contributing.md
- developer-guide/running-locally.md
docs: Add remote debugging example to contribution docs docs: fix grammar Minor editing empty
2020-08-24 14:39:51 +00:00
- developer-guide/debugging-remote-environment.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- developer-guide/api-docs.md
- developer-guide/test-e2e.md
docs: Add developer docs for gitops-engine changes (#4492) Signed-off-by: Keith Chong <kykchong@redhat.com>
2020-10-06 17:31:57 +00:00
- developer-guide/dependencies.md
Build ArgoCD on CircleCI (#1635)
2019-05-28 18:39:13 +00:00
- developer-guide/ci.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- developer-guide/releasing.md
- developer-guide/site.md
chore: Containerize complete build & test toolchain (#3245) chore: Containerize complete build & test toolchain
2020-03-27 18:36:20 +00:00
- developer-guide/faq.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- faq.md
docs: document built-in user limitations and workaround (#3341) * document security limitations * minor issue description revisions + formatting * Update security.md * move CVEs description into separate document Co-authored-by: Matt Hamilton <matt@soluble.ai> Co-authored-by: Ed Lee <edlee2121@users.noreply.github.com>
2020-04-04 06:43:21 +00:00
- security_considerations.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- Support: SUPPORT.md
docs: add roadmap document (#3906) * docs: add first roadmap draft * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * Update docs/roadmap.md Co-authored-by: Ishita Sequeira <46771830+ishitasequeira@users.noreply.github.com> * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * Update docs/roadmap.md Co-authored-by: Ishita Sequeira <46771830+ishitasequeira@users.noreply.github.com> * Update docs/roadmap.md Co-authored-by: Ishita Sequeira <46771830+ishitasequeira@users.noreply.github.com> * update table on content; add argocd-image-updater-link * Update docs/roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> * add more information about ApplicationSet project * Update roadmap.md Co-authored-by: Remington Breeze <remington@breeze.software> Co-authored-by: Ishita Sequeira <46771830+ishitasequeira@users.noreply.github.com> Co-authored-by: Ed Lee <edlee2121@users.noreply.github.com>
2020-08-13 19:32:44 +00:00
- roadmap.md
Create docs website (#1387) Closes #1390
2019-04-05 22:12:27 +00:00
- Releases ⧉: https://github.com/argoproj/argo-cd/releases
Fixes doc bugs. Closes #1395 (#1403)
2019-04-09 18:01:04 +00:00
- Blog ⧉: https://blog.argoproj.io/
Reference in a new issue Copy permalink