Skip to content

docs: document name-only secret references #16

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.

Sign up for GitHub

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

Open
mkl262 wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

docs: document name-only secret references #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions references/generator-yaml-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ deletable:

If the resource is NOT in an allowed state, the delete is requeued.

### Spec CEL Validations

Adds kubebuilder `XValidation` markers to the generated resource Spec:

```yaml
spec_validations:
- rule: "!has(self.importFrom) || !has(self.certificate)"
message: "importFrom and certificate are mutually exclusive"
```

Both `rule` and `message` are required. Rules use Kubernetes CEL syntax and
are enforced by CRD admission.

### Tags

```yaml
Expand Down Expand Up @@ -215,6 +228,7 @@ operations:
| `is_arn` | bool | Override default ARN field detection |
| `is_attribute` | bool | Field is part of an Attributes map (SNS/SQS pattern) |
| `is_secret` | bool | Field becomes a SecretKeyReference |
| `is_secret_reference` | bool | Field becomes a name/namespace-only SecretReference when the controller owns the data-key convention |

### Immutability

Expand Down