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

Add documentation for enabling/disabling argocd core components #1132

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Add documentation for enabling/disabling argocd core components #1132

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cbc81f
Add documentation for enabling/disabling argocd core components
ishitasequeira Jan 5, 2024
81e0f35
Address comments
ishitasequeira Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions docs/usage/enabling-disabling-argocd-core-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Enabling/Disabling Core Components of ArgoCD
The Operator oversees all Argo CD workloads, including the API server, repository server, application controller, and more.

Currently, the following workloads are managed:

* argocd-server (API server and UI)
* argocd-repo-server (Repository server)
* argocd-application-controller (Main reconciliation controller)
* argocd-applicationset-controller (ApplicationSet reconciliation controller)
* argocd-redis (volatile cache)

To support installations with minimal resource requirements and to facilitate distribution across clusters or namespaces, the ability to selectively install specific Argo CD components has been introduced.

To enable/disable a particular Argo CD component, a new flag, `spec.<component>.enabled`, has been implemented. The default value of the flag is `true`, implying that if the flag is unspecified, the Argo CD workload is enabled by default.

To disable a specific Argo CD component, set the `spec.<component>.enabled` flag to `false`.

Consider the following example:

```yaml
apiVersion: argoproj.io/v1beta1
kind: ArgoCD
metadata:
name: example
spec:
controller:
enabled: false
```

In this example, only the controller component is disabled, while all other components continue to run normally.

# Specifying External URLs for Redis and RepoServer Components
When disabling core components like Redis or Repo Server, you may wish to provide an external URL for components running in external clusters. The remote URL can be set using the `spec.<component>.remote` flag (component can either be `redis` or `repo`).

For example,

```yaml
apiVersion: argoproj.io/v1beta1
kind: ArgoCD
metadata:
name: example
spec:
repo:
enabled: false
remote: 'https://www.example.com/repo-server'
```

!!! Note: The remote flag can only be set if the enabled flag of the component is set to false.
Loading