Skip to content

clearer instruction to disable default argocd instance #412

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

Open
makeittotop wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −1
Open

clearer instruction to disable default argocd instance #412

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion docs/OpenShift GitOps Usage Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,20 @@ openshift-gitops-server-86df579bbf-zz9lx 1/1 Running 0

When installing the OpenShift GitOps operator to ROSA/OSD, cluster administrators may wish to exclude users from modifying resources within the *openshift-** namespaces, including the *openshift-gitops* namespace which is the default location for an Argo CD install.

To disable the default ‘ready-to-use’ installation of Argo CD: as an admin, update the existing Subscription Object for Gitops Operator and add `DISABLE_DEFAULT_ARGOCD_INSTANCE = true` to the spec.
To disable the default ‘ready-to-use’ installation of Argo CD: as an admin, update the existing Subscription Object for Gitops Operator and add `DISABLE_DEFAULT_ARGOCD_INSTANCE = true` to the `subscriptions.operators.coreos.com.spec.config.env` resource as follows -

```

@coderabbitai coderabbitai Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Declare the fenced block as YAML.

Use ```yaml instead of an untyped fence to satisfy markdownlint MD040 and provide correct syntax highlighting.

🧰 Tools
🪛 markdownlint-cli2 (0.23.1)

[warning] 124-124: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/OpenShift` GitOps Usage Guide.md at line 124, Update the fenced code
block in the OpenShift GitOps Usage Guide to use a yaml language identifier,
changing the opening fence to ```yaml while preserving the block contents and
closing fence.

Source: Linters/SAST tools

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
name: openshift-gitops-operator
namespace: openshift-operators
spec:
config:
Comment on lines +125 to +130

@coderabbitai coderabbitai Bot Jul 29, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Add the missing metadata: key to the Subscription example.

name and namespace are currently indented beneath the scalar kind field, so this block is invalid YAML and cannot be applied.

Proposed fix 
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
+metadata:
   name: openshift-gitops-operator
   namespace: openshift-operators
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
name: openshift-gitops-operator
namespace: openshift-operators
spec:
config:
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: openshift-gitops-operator
namespace: openshift-operators
spec:
config:
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/OpenShift` GitOps Usage Guide.md around lines 125 - 130, Correct the
Subscription YAML example by adding the missing metadata mapping before name and
namespace, keeping those fields nested under metadata and preserving kind as its
own top-level field.

env:
- name: DISABLE_DEFAULT_ARGOCD_INSTANCE
value: "TRUE"

```

**Warning**: setting this option to true will cause the existing Argo CD install in the *openshift-gitops* namespace to be deleted. Argo CD instances in other namespaces should not be affected.

Expand Down