Skip to content

Commit

Permalink
Update documentation after gocardless#276
Browse files Browse the repository at this point in the history
After removed pod priority mutate webhook these docs are not relevant
anymore.

gocardless#276

Signed-off-by: Raúl Naveiras <me@raulnaveiras.com>
  • Loading branch information
rnaveiras committed Jun 14, 2023
1 parent 4a2eb77 commit 8d2c572
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 19 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ expected to create or mutate pods, deployments, etc.
- [Consoles](controllers/workloads/console/README.md): Provide engineers with a temporary
dedicated pod to perform operational tasks, avoiding the need to provide
`pods/exec` permissions on production workloads.
- [Default priority classes](apis/workloads/v1alpha1/README.md): Mutate all pods within a
namespace to set a default priority class.

### [Vault](apis/vault/v1alpha1/README.md)

Expand Down
18 changes: 1 addition & 17 deletions apis/workloads/v1alpha1/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,7 @@
# Workloads

This package contains the CRDs and webhooks for
[Consoles](../../../controllers/workloads/console/README.md) and [Default priority
classes](#default-priority-classes).
This package contains the CRDs and webhooks for:

## Consoles

See [Consoles controller documentation](../../../controllers/workloads/console/README.md).

## Default Priority Classes

Priority classes can be really useful to separate critical from optional
workloads. It's normal for all workloads within a particular namespace to have
the same priority class, but it's not possible to set a default on a namespace.

This package implements a webhook that permits setting a default priority class
for a given namespace. By applying the label `theatre-priority-injector:
<priority-class-name>` onto your namespace, you'll activate the webhook for all
pods.

If a pod already has a priority class, it will be ignored. Otherwise the pods
priority is set to match that of the namespace label.

0 comments on commit 8d2c572

Please sign in to comment.