Temporary configuration
A platform operator offers a ConfigMap with a validated message. A team member requests an instance for 20 minutes, and a reviewer approves the rendered resource. The controller creates it, protects it while active, and removes it when the permit expires. The permit remains for seven days as an audit record.
This is the pair shown in the interactive homepage example.
Prerequisites
Install Resource Permits.
This example works without Capsule. Use an existing namespace named solar-system,
or create it with kubectl create namespace solar-system. Change the namespace
consistently in all manifests if needed. The requester must be authorized to create and read
ResourcePermits there. The reviewer needs read access and permission to update
resourcepermits/status, as well as membership in platform-on-call.
The combined manifest below includes the executor ServiceAccount and its namespace-scoped ConfigMap permissions. Apply it as the platform operator. Listing an approver in a template does not grant Kubernetes RBAC.
When using Capsule, its namespace assignment and tenant permissions guides explain how to prepare the tenant namespace and its users.
Define the template
The template accepts one message parameter. It uses the permit’s name for the
ConfigMap name and the authenticated requester for requestedBy. Namespaced targets
without an explicit namespace are placed in the permit namespace.
apiVersion: v1
kind: ServiceAccount
metadata:
name: permit-config-writer
namespace: solar-system
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: permit-config-writer
namespace: solar-system
rules:
- apiGroups: [""]
resources: ["configmaps"]
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: permit-config-writer
namespace: solar-system
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: permit-config-writer
subjects:
- kind: ServiceAccount
name: permit-config-writer
namespace: solar-system
---
apiVersion: addons.projectcapsule.dev/v1beta2
kind: ResourcePermitTemplate
metadata:
name: temporary-config
namespace: solar-system
spec:
defaultDuration: 30m
maxDuration: 2h
keepFor: 7d
impersonation:
name: permit-config-writer
approvals:
auto: false
approvers:
- kind: Group
name: platform-on-call
paramSchema:
type: object
additionalProperties: false
required: [message]
properties:
message:
type: string
minLength: 1
maxLength: 200
resources:
- policy:
creation: Owner
protect: true
force: false
deletion: Remove
targets:
- apiVersion: v1
kind: ConfigMap
metadata:
name: '{{ .request.name }}'
data:
message: '{{ .message }}'
requestedBy: '{{ .request.username }}'Download platform/resourcepermittemplates/temporary-config.yaml
Apply the combined executor permissions and template, then wait for template readiness:
kubectl apply -f playground/manifests/platform/resourcepermittemplates/temporary-config.yaml
kubectl wait --for=condition=Ready resourcepermittemplate/temporary-config -n solar-system --timeout=60sSee template scope and readiness and resource policies.
Request an instance
Submit this as the requesting team member. The reference resolves to the template in the same namespace. Its requested 20-minute duration is below the two-hour limit.
apiVersion: addons.projectcapsule.dev/v1beta2
kind: ResourcePermit
metadata:
name: investigate-checkout
namespace: solar-system
spec:
template:
kind: ResourcePermitTemplate
name: temporary-config
params:
message: Checkout investigation in progress
reason: Investigate checkout failures for INC-1042
duration: 20mDownload user/solar/resourcepermits/temporary-config.yaml
kubectl create -f playground/manifests/user/solar/resourcepermits/temporary-config.yaml
kubectl get resourcepermit investigate-checkout -n solar-system -o yamlWait for phase Requested, then inspect .status.request.resources: those are the
concrete manifests the reviewer will approve. An empty message, an unknown
parameter, or a duration above 2h is invalid. A request cannot use this namespaced
template from a different namespace.
Review and observe cleanup
With the
kubectl plugin
installed, a member of platform-on-call reviews the permit:
kubectl resource-permits review investigate-checkout -n solar-systemApprove the request in the interactive review. Without a future start time, it can
activate immediately. Once its phase is Active, inspect the managed object:
kubectl get configmap investigate-checkout -n solar-system -o yamlIts data.message matches the request and data.requestedBy identifies the
requester. On expiry, the controller removes the ConfigMap according to
deletion: Remove. The permit transitions to Expired and remains for keepFor: 7d.
An authorized operator can also
expire it early.