argo-cd/docs/user-guide
jannfis be718e2b61
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 18:21:53 +02:00
..
app_deletion.md Fixed description of non-cascade command in App Deletion (#3173) 2020-03-02 18:01:05 +01:00
application_sources.md Adds support for ARGO_CD_[TARGET_REVISION|REVISION] and pass to Custom Tool/Helm/Jsonnet (#2415) 2019-10-21 16:54:23 -07:00
auto_sync.md feat(ui): add docs to sync policy options present in create application panel (Close #3098) (#3203) 2020-03-07 18:03:15 +01:00
best_practices.md docs: Updated best practices to remove typos. (#3410) 2020-04-14 12:26:09 +02:00
build-environment.md fix: update documentation for adding environment variable KUBE_VERSION and KUBE_API_VERSION (#3323) 2020-03-31 20:21:39 -07:00
ci_automation.md Create docs website (#1387) Closes #1390 2019-04-05 15:12:27 -07:00
compare-options.md Adds Validate=false that disables validation when applying resources.… (#1750) 2019-06-18 14:07:26 -07:00
config-management-plugins.md Adds support for ARGO_CD_[TARGET_REVISION|REVISION] and pass to Custom Tool/Helm/Jsonnet (#2415) 2019-10-21 16:54:23 -07:00
diffing.md docs: Fix diffing_known_types.txt link (#3381) 2020-04-08 19:03:07 +02:00
gpg-verification.md feat: GPG commit signature verification (#2492) (#3242) 2020-06-22 18:21:53 +02:00
helm.md docs: Add docs how to use ArgoCD with helm plugins (#3766) 2020-06-17 10:11:54 -07:00
index.md Create docs website (#1387) Closes #1390 2019-04-05 15:12:27 -07:00
jsonnet.md Correct version of Argo CD that build env is available in. See #2749 (#2750) 2019-11-21 14:37:45 -08:00
ksonnet.md Adds support for ARGO_CD_[TARGET_REVISION|REVISION] and pass to Custom Tool/Helm/Jsonnet (#2415) 2019-10-21 16:54:23 -07:00
kustomize.md docs: v1.5.3 changelog (#3526) 2020-04-30 13:17:44 -07:00
orphaned-resources.md chore: Spelling - md files (#3651) 2020-05-26 13:58:29 -07:00
parameters.md Create docs website (#1387) Closes #1390 2019-04-05 15:12:27 -07:00
private-repositories.md docs: typo/punctuation in tracking_strategies.md (#3449) 2020-05-15 18:25:23 +02:00
projects.md feat: Support cluster name on Application destination. Closes #1548 (#2808) 2020-06-20 16:12:46 -07:00
resource_hooks.md docs: Use official curl image instead of appropriate/curl (#3695) 2020-06-02 18:45:15 +02:00
selective_sync.md Helm hooks. Closes #355 (#2069) 2019-08-12 15:34:21 -07:00
status-badge.md Improve status badge feature (#1844) 2019-07-01 12:10:36 -07:00
sync-options.md chore: Spelling - md files (#3651) 2020-05-26 13:58:29 -07:00
sync-waves.md Adds Validate=false that disables validation when applying resources.… (#1750) 2019-06-18 14:07:26 -07:00
sync_windows.md Fix logic when checking sync window status using the cli (#2456) 2019-10-09 16:06:14 -07:00
tool_detection.md Refine docs: How to explicitly select a tool (#3261) 2020-03-23 09:54:09 -07:00
tracking_strategies.md docs: typo/punctuation in tracking_strategies.md (#3449) 2020-05-15 18:25:23 +02:00