You can choose either one of the following two approaches to create a Workload
for your application by using the registry credentials specified, add credentials and Role-Based Access Control (RBAC) rules to the namespace that you plan to create the Workload
in:
If you plan to install Out of the Box Supply Chain with testing and scanning, follow additional steps to configure the developer namespace for that use case.
Follow these steps to enable your current user to submit jobs to the Supply Chain:
To add read/write registry credentials to the developer namespace, run:
tanzu secret registry add registry-credentials --server REGISTRY-SERVER --username REGISTRY-USERNAME --password REGISTRY-PASSWORD --namespace YOUR-NAMESPACE
Where:
YOUR-NAMESPACE
is the name you give to the developer namespace. For example, use default
for the default namespace.REGISTRY-SERVER
is the URL of the registry. For Docker Hub, this must be https://index.docker.io/v1/
. Specifically, it must have the leading https://
, the v1
path, and the trailing /
. For Google Container Registry (GCR), this is gcr.io
. Based on the information used in Installing the Tanzu Application Platform Package and Profiles, you can use the same registry server as in ootb_supply_chain_basic
- registry
- server
.REGISTRY-PASSWORD
is the password of the registry. For GCR or Google Artifact Registry, this must be the concatenated version of the JSON key. For example: "$(cat ~/gcp-key.json)"
.If you observe the following issue with the above command:
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x128 pc=0x2bcce00]
Use kubectl
to create the secret:
kubectl create secret docker-registry registry-credentials --docker-server=REGISTRY-SERVER --docker-username=REGISTRY-USERNAME --docker-password=REGISTRY-PASSWORD -n YOUR-NAMESPACE
NoteThis step is not required if you install Tanzu Application Platform on AWS with EKS and use IAM Roles for Kubernetes Service Accounts instead of secrets. You can specify the Role Amazon Resource Name (ARN) in the next step.
To add secrets, a service account to execute the supply chain, and RBAC rules to authorize the service account to the developer namespace, run:
cat <<EOF | kubectl -n YOUR-NAMESPACE apply -f -
apiVersion: v1
kind: Secret
metadata:
name: tap-registry
annotations:
secretgen.carvel.dev/image-pull-secret: ""
type: kubernetes.io/dockerconfigjson
data:
.dockerconfigjson: e30K
---
apiVersion: v1
kind: ServiceAccount
metadata:
name: default
secrets:
- name: registry-credentials
imagePullSecrets:
- name: registry-credentials
- name: tap-registry
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: default-permit-deliverable
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: deliverable
subjects:
- kind: ServiceAccount
name: default
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: default-permit-workload
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: workload
subjects:
- kind: ServiceAccount
name: default
EOF
NoteIf you install Tanzu Application Platform on AWS with EKS and use IAM Roles for Kubernetes Service Accounts, you must annotate the ARN of the IAM Role and remove the
registry-credentials
secret. Your service account entry then looks like the following:
apiVersion: v1
kind: ServiceAccount
metadata:
name: default
annotations:
eks.amazonaws.com/role-arn: <Role ARN>
imagePullSecrets:
- name: tap-registry
Follow these steps to enable additional users by using Kubernetes RBAC to submit jobs to the Supply Chain:
Choose either of the following options to give developers namespace-level access and view access to appropriate cluster-level resources:
Option 1: Use the Tanzu Application Platform RBAC CLI plug-in (beta).
To use the tanzu rbac
plug-in to grant app-viewer
and app-editor
roles to an identity provider group, run:
tanzu rbac binding add -g GROUP-FOR-APP-VIEWER -n YOUR-NAMESPACE -r app-viewer
tanzu rbac binding add -g GROUP-FOR-APP-EDITOR -n YOUR-NAMESPACE -r app-editor
Where:
YOUR-NAMESPACE
is the name you give to the developer namespace.GROUP-FOR-APP-VIEWER
is the user group from the upstream identity provider that requires access to app-viewer
resources on the current namespace and cluster.GROUP-FOR-APP-EDITOR
is the user group from the upstream identity provider that requires access to app-editor
resources on the current namespace and cluster.For more information about tanzu rbac
, see Bind a user or group to a default role.
VMware recommends creating a user group in your identity provider’s grouping system for each developer namespace and then adding the users accordingly.
Depending on your identity provider, you might need to take further action to federate user groups appropriately with your cluster. For an example of how to set up Azure Active Directory (AD) with your cluster, see Integrating Azure Active Directory.
Option 2: Use the native Kubernetes YAML.
To apply the RBAC policy, run:
cat <<EOF | kubectl -n YOUR-NAMESPACE apply -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: dev-permit-app-viewer
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: app-viewer
subjects:
- kind: Group
name: GROUP-FOR-APP-VIEWER
apiGroup: rbac.authorization.k8s.io
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: YOUR-NAMESPACE-permit-app-viewer
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: app-viewer-cluster-access
subjects:
- kind: Group
name: GROUP-FOR-APP-VIEWER
apiGroup: rbac.authorization.k8s.io
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: dev-permit-app-editor
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: app-editor
subjects:
- kind: Group
name: GROUP-FOR-APP-EDITOR
apiGroup: rbac.authorization.k8s.io
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: YOUR-NAMESPACE-permit-app-editor
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: app-editor-cluster-access
subjects:
- kind: Group
name: GROUP-FOR-APP-EDITOR
apiGroup: rbac.authorization.k8s.io
EOF
Where:
YOUR-NAMESPACE
is the name you give to the developer namespace.GROUP-FOR-APP-VIEWER
is the user group from the upstream identity provider that requires access to app-viewer
resources on the current namespace and cluster.GROUP-FOR-APP-EDITOR
is the user group from the upstream identity provider that requires access to app-editor
resources on the current namespace and cluster.VMware recommends creating a user group in your identity provider’s grouping system for each developer namespace and then adding the users accordingly.
Depending on your identity provider, you might need to take further action to federate user groups appropriately with your cluster. For an example of how to set up Azure Active Directory (AD) with your cluster, see Integrating Azure Active Directory.
Rather than granting roles directly to individuals, VMware recommends using your identity provider’s user groups system to grant access to a group of developers. For an example of how to set up Azure AD with your cluster, see Integrating Azure Active Directory.
(Optional) Log in as a non-admin user, such as a developer, to see the effects of RBAC after the bindings are applied.
If you plan to install Out of the Box Supply Chains with Testing and Scanning, see the Developer Namespace section.