You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: enhancements/security/internal-pki-config.md
+36-28Lines changed: 36 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,12 +77,14 @@ Currently, OpenShift provides no mechanism to configure these parameters for int
77
77
78
78
## Proposal
79
79
80
-
This proposal introduces a new `PKI` cluster-scoped singleton configuration resource in the `config.openshift.io/v1alpha1` API group, along with a `ConfigurablePKI` feature gate to control the rollout. The configuration allows administrators to specify cryptographic parameters for internal certificates organized by category and name.
80
+
This proposal introduces a new `PKI` cluster-scoped singleton configuration resource in the `config.openshift.io/v1` API group, along with a `ConfigurablePKI` feature gate to control the rollout. The configuration allows administrators to specify cryptographic parameters for internal certificates organized by category and name.
81
+
82
+
**Note:** During development, the API will start as `v1alpha1` with TechPreviewNoUpgrade feature gate enablement. The API will be promoted to `v1` and the feature gate will be enabled by default before the OpenShift 4.21 release, shipping as GA.
81
83
82
84
At a high level, the changes include:
83
85
84
-
1.**New API Resource**: `PKI` configuration resource in `config.openshift.io/v1alpha1` (cluster-scoped singleton)
85
-
2.**Feature Gate**: `ConfigurablePKI` to enable the functionality
86
+
1.**New API Resource**: `PKI` configuration resource in `config.openshift.io/v1` (cluster-scoped singleton, developed as v1alpha1 initially)
87
+
2.**Feature Gate**: `ConfigurablePKI` to enable the functionality (TechPreviewNoUpgrade during development, enabled by default at GA)
86
88
3.**Installer Integration**: Limited Day-1 configuration support for signer certificate cryptographic parameters
87
89
4.**Operator Updates**: Modifications to certificate-generating operators to watch and consume the PKI configuration independently
88
90
5.**Certificate Rotation**: Integration with existing rotation mechanisms to apply new parameters
@@ -132,7 +134,7 @@ oc edit pki cluster
132
134
2. The administrator modifies the PKI resource:
133
135
134
136
```yaml
135
-
apiVersion: config.openshift.io/v1alpha1
137
+
apiVersion: config.openshift.io/v1
136
138
kind: PKI
137
139
metadata:
138
140
name: cluster
@@ -212,45 +214,45 @@ This enhancement adds a new Custom Resource Definition (CRD) to the OpenShift AP
212
214
213
215
#### Compatibility Level
214
216
215
-
The PKI API starts at **Compatibility Level 4** (TechPreviewNoUpgrade):
217
+
The PKI API will be developed initially at **Compatibility Level 4** (TechPreviewNoUpgrade) and graduate to **Compatibility Level 1** (GA) before the OpenShift 4.21 release.
216
218
217
-
- **Level 4 characteristics:**
218
-
- No compatibility guarantees
219
+
- **Development phase (v1alpha1, Level 4):**
220
+
- No compatibility guarantees during development
219
221
- API can change at any point for any reason
220
222
- Breaking changes are allowed without migration path
221
223
- Suitable for iterative development and testing
222
-
- Not recommended for production workloads requiring long-term support
224
+
- Gated by ConfigurablePKI feature gate with TechPreviewNoUpgrade enablement
- Level 2 (TechPreview) → after initial feedback and stabilization
227
-
- Level 1 (GA/Stable) → after one or more releases in TechPreview
226
+
- **Release phase (v1, Level 1):**
227
+
- Shipped as GA in OpenShift 4.21
228
+
- Breaking changes no longer allowed
229
+
- API stable within major release for 12 months or 3 minor releases
230
+
- Full backward compatibility guarantees
228
231
229
-
- **Version progression:**
230
-
- v1alpha1 at Level 4: current proposal
231
-
- v1beta1 at Level 2: potential future state
232
-
- v1 at Level 1: eventual GA state
232
+
- **Graduation timeline:**
233
+
- v1alpha1 at Level 4: Early development (feature gate: TechPreviewNoUpgrade)
234
+
- v1 at Level 1: OpenShift 4.21 release (feature gate: enabled by default)
235
+
- No intermediate v1beta1 or TechPreview release planned
233
236
234
-
The compatibility level is enforced through the `+openshift:compatibility-gen:level=4` annotation and will be validated by the API review process.
237
+
The compatibility level is enforced through the `+openshift:compatibility-gen:level` annotation and will be validated by the API review process. The annotation will change from `level=4` to `level=1` when the API is promoted to v1.
235
238
236
239
#### PKI Resource
237
240
238
-
The `PKI` resource is a cluster-scoped singleton named `cluster` in the `config.openshift.io/v1alpha1` API group.
241
+
The `PKI` resource is a cluster-scoped singleton named `cluster` in the `config.openshift.io/v1` API group (initially developed as v1alpha1 during the development phase).
239
242
240
243
```go
241
244
// PKI configures cryptographic parameters for certificates generated
242
245
// internally by OpenShift components.
243
246
//
244
-
// Compatibility level 4: No compatibility is provided, the API can change at any point for any reason.
245
-
// These capabilities should not be used by applications needing long term support.
247
+
// Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
0 commit comments