docs: update config management plugin docs #11690
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #11690 +/- ##
=========================================
Coverage ? 47.62%
=========================================
Files ? 246
Lines ? 41797
Branches ? 0
=========================================
Hits ? 19907
Misses ? 19897
Partials ? 1993 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
harikrongali
reviewed
Jan 9, 2023
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
jsoref
reviewed
Jan 30, 2023
cmd/argocd/commands/app.go
Outdated
| @@ -967,7 +967,7 @@ func NewApplicationDiffCommand(clientOpts *argocdclient.ClientOptions) *cobra.Co | |||
|
|
|||
| diffOption.serversideRes = res | |||
| } else { | |||
| fmt.Fprintf(os.Stderr, "Warning: local diff without --server-side-generate is deprecated and does not work with plugins. Server-side generation will be the default in v2.6.") | |||
| fmt.Fprintf(os.Stderr, "Warning: local diff without --server-side-generate is deprecated and does not work with plugins. Server-side generation will be the default in v2.7.") | |||
There was a problem hiding this comment.
Suggested change
| fmt.Fprintf(os.Stderr, "Warning: local diff without --server-side-generate is deprecated and does not work with plugins. Server-side generation will be the default in v2.7.") | |
| fmt.Fprintf(os.Stderr, "Warning: local diff without --server-side-generate is deprecated and does not work with plugins. Server-side generation will hopefully be the default in v2.7.") |
common/common.go
Outdated
| @@ -222,11 +222,11 @@ const ( | |||
| // DefaultCMPWorkDirName defines the work directory name used by the cmp-server | |||
| DefaultCMPWorkDirName = "_cmp_server" | |||
|
|
|||
| ConfigMapPluginDeprecationWarning = "argocd-cm plugins are deprecated, and support will be removed in v2.6. Upgrade your plugin to be installed via sidecar. https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/" | |||
| ConfigMapPluginDeprecationWarning = "argocd-cm plugins are deprecated, and support will be removed in v2.7. Upgrade your plugin to be installed via sidecar. https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/" | |||
There was a problem hiding this comment.
Suggested change
| ConfigMapPluginDeprecationWarning = "argocd-cm plugins are deprecated, and support will be removed in v2.7. Upgrade your plugin to be installed via sidecar. https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/" | |
| ConfigMapPluginDeprecationWarning = "argocd-cm plugins are deprecated, and support will hopefully be removed in v2.7. Upgrade your plugin to be installed via sidecar. https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/" |
common/common.go
Outdated
|
|
||
| ConfigMapPluginCLIDeprecationWarning = "spec.plugin.name is set, which means this Application uses a plugin installed in the " + | ||
| "argocd-cm ConfigMap. Installing plugins via that ConfigMap is deprecated in Argo CD v2.5. " + | ||
| "Starting in Argo CD v2.6, this Application will fail to sync. Contact your Argo CD admin " + | ||
| "Starting in Argo CD v2.7, this Application will fail to sync. Contact your Argo CD admin " + |
There was a problem hiding this comment.
This form of the text should only have been used once 2.7 removed the feature.
Suggested change
| "Starting in Argo CD v2.7, this Application will fail to sync. Contact your Argo CD admin " + | |
| "It is expected that as of Argo CD v2.7, this Application will fail to sync. Contact your Argo CD admin " + |
@crenshaw-dev note that these messages may have to be deleted anyway.
| @@ -34,7 +34,7 @@ p, role:org-admin, exec, create, *, allow | |||
| ## argocd-cm plugins (CMPs) are deprecated | |||
|
|
|||
| Starting with Argo CD v2.5, installing config management plugins (CMPs) via the `argocd-cm` ConfigMap is deprecated. | |||
| Support will be removed in v2.6. | |||
| ~~Support will be removed in v2.6.~~ Support will be removed in v2.7. | |||
There was a problem hiding this comment.
Suggested change
| ~~Support will be removed in v2.6.~~ Support will be removed in v2.7. | |
| ~~Support will be removed in v2.6.~~ Support will probably be removed in v2.7. |
| @@ -47,6 +47,8 @@ following message: | |||
|
|
|||
| > argocd-cm plugins are deprecated, and support will be removed in v2.6. Upgrade your plugin to be installed via sidecar. https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/ | |||
|
|
|||
| **NOTE:** removal of argocd-cm plugin support was delayed to v2.7. Update your logs scan to use `v2.7` instead of `v2.6`. | |||
There was a problem hiding this comment.
Suggested change
| **NOTE:** removal of argocd-cm plugin support was delayed to v2.7. Update your logs scan to use `v2.7` instead of `v2.6`. | |
| **NOTE:** removal of argocd-cm plugin support is currently delayed to v2.7. Update your logs scan to look for `https://argo-cd.readthedocs.io/en/stable/user-guide/config-management-plugins/` instead. |
| @@ -20,47 +20,15 @@ The following sections will describe how to create, install, and use plugins. Ch | |||
|
|
|||
| There are two ways to install a Config Management Plugin: | |||
There was a problem hiding this comment.
Suggested change
| There are two ways to install a Config Management Plugin: | |
| From v2.5 and going forward there are two ways to install a Config Management Plugin: |
Comment on lines
23
to
29
| 1. Add the plugin as a sidecar to the repo-server Pod. | ||
| This is a good option for a more complex plugin that would clutter the Argo CD ConfigMap. A copy of the repository is | ||
| sent to the sidecar container as a tarball and processed individually per application, which makes it a good option | ||
| for [concurrent processing of monorepos](../operator-manual/high_availability.md#enable-concurrent-processing). | ||
| 2. Add the plugin config to the Argo CD ConfigMap (**this method is deprecated and will be removed in a future | ||
| version**). The repo-server container will run your plugin's commands. This is a good option for a simple plugin that | ||
| requires only a few lines of code that fit nicely in the Argo CD ConfigMap. |
There was a problem hiding this comment.
Don't rely on numbers, name the bullets and then use the same names for the section titles below.
Use a plugin not the plugin as users can have multiple (I have two) -- and it's quite possible for them to migrate incrementally (I'd recommend that...).
Suggested change
| 1. Add the plugin as a sidecar to the repo-server Pod. | |
| This is a good option for a more complex plugin that would clutter the Argo CD ConfigMap. A copy of the repository is | |
| sent to the sidecar container as a tarball and processed individually per application, which makes it a good option | |
| for [concurrent processing of monorepos](../operator-manual/high_availability.md#enable-concurrent-processing). | |
| 2. Add the plugin config to the Argo CD ConfigMap (**this method is deprecated and will be removed in a future | |
| version**). The repo-server container will run your plugin's commands. This is a good option for a simple plugin that | |
| requires only a few lines of code that fit nicely in the Argo CD ConfigMap. | |
| * Sidecar plugin | |
| Add a plugin as a sidecar to the repo-server Pod. | |
| This is recommended. A copy of the repository is | |
| sent to the sidecar container as a tarball and processed individually per application, which makes it a good option | |
| for [concurrent processing of monorepos](../operator-manual/high_availability.md#enable-concurrent-processing). | |
| * ConfigMap plugin | |
| (Deprecated) | |
| Add a plugin config to the Argo CD ConfigMap (**this method is deprecated and will be removed in a future | |
| version**). The repo-server container will run your plugin's commands. This is a good option for a simple plugin that | |
| requires only a few lines of code that fit nicely in the Argo CD ConfigMap. | |
|
|
||
| ### Option 2: Configure plugin via sidecar | ||
| ### Option 1: Configure plugin via sidecar |
There was a problem hiding this comment.
Suggested change
| ### Option 1: Configure plugin via sidecar | |
| ### Sidecar plugin |
| - name: REV | ||
| value: test-$ARGOCD_APP_REVISION | ||
| ``` | ||
| ### Option 2: Configure plugins via Argo CD configmap (deprecated) |
There was a problem hiding this comment.
Suggested change
| ### Option 2: Configure plugins via Argo CD configmap (deprecated) | |
| ### ConfigMap plugin |
| @@ -450,17 +440,16 @@ spec: | |||
| The `lockRepo` key is not relevant for sidecar plugins, because sidecar plugins do not share a single source repo | |||
| directory when generating manifests. | |||
|
|
|||
| ### 2. Write discovery rules for your plugin | |||
| ### 2. Write discovery rules for your plugin, or use the plugin name | |||
There was a problem hiding this comment.
As noted above, don't include numbers or periods or colons in section headings in general as they're really painful for link / search purposes.
Use very short text items so that users can scan/click/etc.
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
crenshaw-dev
added a commit
that referenced
this pull request
Feb 6, 2023
* docs: update config management plugin docs Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * update plugin name/discovery section Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * don't remove client-side gen Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> * fixes Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com> --------- Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
|
Cherry-picked onto release-2.6 for 2.6.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates references to argocd-cm support removal.
It also makes argocd-cm plugins the second option listed in the docs.
Fixes #11689
Finally, it fixes some formatting issues.