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.

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

docs: Add section on how to lock down/restrict the default project #21757

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

dag-andersen
Copy link

@dag-andersen dag-andersen commented Feb 3, 2025

Motivation
This section clarifies how to lock down the default project — something that wasn’t immediately clear in the original documentation. By outlining the steps to restrict its default permissions, it helps teams maintain tighter security and safer clusters.

Related to this GitHub Issue: Restrict the default project #11058

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

@dag-andersen dag-andersen requested review from a team as code owners February 3, 2025 20:46
Copy link

bunnyshell bot commented Feb 3, 2025

✅ Preview Environment deployed on Bunnyshell

Component Endpoints
argocd https://argocd-lowbwn.bunnyenv.com/
argocd-ttyd https://argocd-web-cli-lowbwn.bunnyenv.com/

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔴 /bns:stop to stop the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Big fan of this! One note.

sourceRepos: []
sourceNamespaces: []
destinations: []
clusterResourceWhitelist: []
Copy link
Member

Choose a reason for hiding this comment

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

clusterResourceWhitelist: [] is the default.

Namespaced resources are all allowed by default. To lock that down, you'd want a ,,* rule for namespaceResourceBlacklist.

Copy link
Author

Choose a reason for hiding this comment

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

Ah, alright!

I've now added namespaceResourceBlacklist instead 👍🏻

Is clusterResourceWhitelist: [] equivalent to:

  clusterResourceWhitelist:
  - group: '*'
    kind: '*'

?

When running argocd proj list, the first option appears as <none>, while the second one shows as */*. Are they treated the same behind the scenes? :)

Copy link
Member

Choose a reason for hiding this comment

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

An empty cluster whitelist is equivalent to "don't allow anything," which is the default. So it's not problematic, just redundant.

Copy link
Author

Choose a reason for hiding this comment

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

Ah, yes! Now I understand — I had flipped it in my mind.
Thanks! 😊

@dag-andersen dag-andersen force-pushed the docs-restrict-default-project branch from 43170ca to ce48044 Compare February 3, 2025 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants