Projects provide a logical grouping of applications, which is useful when Argo CD is used by multiple teams. Projects provide the following features:
- ability to restrict what may be deployed (the git source repositories)
- ability to restrict where apps may be deployed (the destination clusters and namespaces)
- ability to control what type of objects may be deployed (e.g. RBAC, CRDs, DaemonSets, NetworkPolicy etc...)
The default project
Every application belongs to a single project. If unspecified, an application belongs to the
default project, which is created automatically and by default, permits deployments from any
source repo, to any cluster, and all resource Kinds. The default project can be modified, but not
deleted. When initially created, it's specification is configured to be the most permissive:
spec: sourceRepos: - '*' destinations: - namespace: '*' server: '*' clusterResourceWhitelist: - group: '*' kind: '*'
Additional projects can be created to give separate teams different levels of access to namespaces.
The following command creates a new project
myproject which can deploy applications to namespace
mynamespace of cluster
https://kubernetes.default.svc. The permitted git source repository is
argocd proj create myproject -d https://kubernetes.default.svc,mynamespace -s https://github.com/argoproj/argocd-example-apps.git
Permitted source git repositories are managed using commands:
argocd project add-source <PROJECT> <REPO> argocd project remove-source <PROJECT> <REPO>
Permitted destination clusters and namespaces are managed with the commands:
argocd project add-destination <PROJECT> <CLUSTER>,<NAMESPACE> argocd project remove-destination <PROJECT> <CLUSTER>,<NAMESPACE>
Permitted destination K8s resource kinds are managed with the commands. Note that namespaced-scoped resources are restricted via a blacklist, whereas cluster-scoped resources are restricted via whitelist.
argocd project allow-cluster-resource <PROJECT> <GROUP> <KIND> argocd project allow-namespace-resource <PROJECT> <GROUP> <KIND> argocd project deny-cluster-resource <PROJECT> <GROUP> <KIND> argocd project deny-namespace-resource <PROJECT> <GROUP> <KIND>
Assign application to a project
The application project can be changed using
app set command. In order to change the project of
an app, the user must have permissions to access the new project.
argocd app set guestbook-default --project myproject
Configuring RBAC with projects
Once projects have been defined, RBAC rules can be written to restrict access to the applications
in the project. The following example configures RBAC for two GitHub teams:
both in the GitHub org,
some-github-org. There are two projects,
team1 can only manage applications in
team2 can only manage applications in
team2 have the ability to manage repositories.
apiVersion: v1 kind: ConfigMap metadata: name: argocd-rbac-cm data: policy.default: "" policy.csv: | p, some-github-org:team1, applications, *, project-a/*, allow p, some-github-org:team2, applications, *, project-a/*, allow p, role:org-admin, repositories, get, *, allow p, role:org-admin, repositories, create, *, allow p, role:org-admin, repositories, update, *, allow p, role:org-admin, repositories, delete, *, allow g, some-github-org:team1, org-admin g, some-github-org:team2, org-admin
Projects include a feature called roles that enable automated access to a project's applications. These can be used to give a CI pipeline a restricted set of permissions. For example, a CI system may only be able to sync a single app (but not change its source or destination).
Projects can have multiple roles, and those roles can have different access granted to them. These permissions are called policies, and they are stored within the role as a list of policy strings. A role's policy can only grant access to that role and are limited to applications within the role's project. However, the policies have an option for granting wildcard access to any application within a project.
In order to create roles in a project and add policies to a role, a user will need permission to update a project. The following commands can be used to manage a role.
argoproj proj role list argoproj proj role get argoproj proj role create argoproj proj role delete argoproj proj role add-policy argoproj proj role remove-policy
Project roles in itself are not useful without generating a token to associate to that role. Argo CD supports JWT tokens as the means to authenticate to a role. Since the JWT token is associated with a role's policies, any changes to the role's policies will immediately take effect for that JWT token.
The following commands are used to manage the JWT tokens.
argoproj proj role create-token PROJECT ROLE-NAME argoproj proj role delete-token PROJECT ROLE-NAME ISSUED-AT
Since the JWT tokens aren't stored in Argo CD, they can only be retrieved when they are created. A
user can leverage them in the cli by either passing them in using the
--auth-token flag or setting
the ARGOCDAUTHTOKEN environment variable. The JWT tokens can be used until they expire or are
revoked. The JWT tokens can created with or without an expiration, but the default on the cli is
creates them without an expirations date. Even if a token has not expired, it cannot be used if
the token has been revoked.
Below is an example of leveraging a JWT token to access a guestbook application. It makes the assumption that the user already has a project named myproject and an application called guestbook-default.
PROJ=myproject APP=guestbook-default ROLE=get-role argocd proj role create $PROJ $ROLE argocd proj role create-token $PROJ $ROLE -e 10m JWT=<value from command above> argocd proj role list $PROJ argocd proj role get $PROJ $ROLE # This command will fail because the JWT Token associated with the project role does not have a policy to allow access to the application argocd app get $APP --auth-token $JWT # Adding a policy to grant access to the application for the new role argocd proj role add-policy $PROJ $ROLE --action get --permission allow --object $APP argocd app get $PROJ-$ROLE --auth-token $JWT # Removing the policy we added and adding one with a wildcard. argocd proj role remove-policy $PROJ $TOKEN -a get -o $PROJ-$TOKEN argocd proj role remove-policy $PROJ $TOKEN -a get -o '*' # The wildcard allows us to access the application due to the wildcard. argocd app get $PROJ-$TOKEN --auth-token $JWT argocd proj role get $PROJ argocd proj role get $PROJ $ROLE # Revoking the JWT token argocd proj role delete-token $PROJ $ROLE <id field from the last command> # This will fail since the JWT Token was deleted for the project role. argocd app get $APP --auth-token $JWT