Skip to content

Commit

Permalink
initial changes: promote CRS to GA
Browse files Browse the repository at this point in the history
  • Loading branch information
mcbenjemaa committed Nov 1, 2024
1 parent 1d1118f commit a4fa5c8
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 9 deletions.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
- [Experimental Features](./tasks/experimental-features/experimental-features.md)
- [MachinePools](./tasks/experimental-features/machine-pools.md)
- [MachineSetPreflightChecks](./tasks/experimental-features/machineset-preflight-checks.md)
- [ClusterResourceSet](./tasks/experimental-features/cluster-resource-set.md)
- [ClusterClass](./tasks/experimental-features/cluster-class/index.md)
- [Writing a ClusterClass](./tasks/experimental-features/cluster-class/write-clusterclass.md)
- [Changing a ClusterClass](./tasks/experimental-features/cluster-class/change-clusterclass.md)
Expand All @@ -45,6 +44,7 @@
- [Running multiple providers](./tasks/multiple-providers.md)
- [Verification of Container Images](./tasks/verify-container-images.md)
- [Diagnostics](./tasks/diagnostics.md)
- [ClusterResourceSet](./tasks/cluster-resource-set.md)
- [Security Guidelines](./security/index.md)
- [Pod Security Standards](./security/pod-security-standards.md)
- [clusterctl CLI](./clusterctl/overview.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Experimental Feature: ClusterResourceSet (beta)
# ClusterResourceSet (GA)

The `ClusterResourceSet` feature is introduced to provide a way to automatically apply a set of resources (such as CNI/CSI) defined by users to matching newly-created/existing clusters.
`ClusterResourceSet` provides a basic solution for installing & managing resources, while for advanced use cases an addon provider must be used.

**Feature gate name**: `ClusterResourceSet`

**Variable name to enable/disable the feature gate**: `EXP_CLUSTER_RESOURCE_SET`

The `ClusterResourceSet` feature is enabled by default, but can be disabled by setting the `EXP_CLUSTER_RESOURCE_SET` environment variable to `false`.
The `ClusterResourceSet` feature is now GA and is enabled by default, but can be disabled by setting the `EXP_CLUSTER_RESOURCE_SET` environment variable to `false`.

More details on `ClusterResourceSet` can be found at:
[ClusterResourceSet CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20200220-cluster-resource-set.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Following controller manager deployments have to be edited in order to enable/di
* [CAPD](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#capd). Other [Infrastructure Providers](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Providers#infrastructure-provider)
might also require this. Please consult the docs of the concrete [Infrastructure Provider](https://cluster-api.sigs.k8s.io/reference/providers#infrastructure)
regarding this.
* [ClusterResourceSet](./cluster-resource-set.md):

* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
* [ClusterClass](./cluster-class/index.md):
* [CAPI](https://cluster-api.sigs.k8s.io/reference/glossary.html?highlight=Gloss#capi).
Expand All @@ -97,7 +97,6 @@ Following controller manager deployments have to be edited in order to enable/di
## Active Experimental Features

* [MachinePools](./machine-pools.md)
* [ClusterResourceSet](./cluster-resource-set.md)
* [ClusterClass](./cluster-class/index.md)
* [Ignition Bootstrap configuration](./ignition.md)
* [Runtime SDK](runtime-sdk/index.md)
Expand Down
4 changes: 3 additions & 1 deletion exp/addons/api/v1beta1/clusterresourceset_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,9 @@ func (m *ClusterResourceSet) SetV1Beta2Conditions(conditions []metav1.Condition)
// +kubebuilder:storageversion
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="Time duration since creation of ClusterResourceSet"

// ClusterResourceSet is the Schema for the clusterresourcesets API.
// ClusterResourceSet is the Schema for the clusterresourcesets API
// it provides a basic solution for installing & managing resources
// while for advanced use cases an addon provider must be used.
type ClusterResourceSet struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down
3 changes: 2 additions & 1 deletion feature/feature.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ const (
//
// alpha: v0.3
// beta: v0.4
// GA: v1.9

Check failure on line 42 in feature/feature.go

View workflow job for this annotation

GitHub Actions / lint

Comment should end in a period (godot)

Check failure on line 42 in feature/feature.go

View workflow job for this annotation

GitHub Actions / lint

Comment should end in a period (godot)

Check failure on line 42 in feature/feature.go

View workflow job for this annotation

GitHub Actions / lint

Comment should end in a period (godot)

Check failure on line 42 in feature/feature.go

View workflow job for this annotation

GitHub Actions / lint

Comment should end in a period (godot)
ClusterResourceSet featuregate.Feature = "ClusterResourceSet"

// ClusterTopology is a feature gate for the ClusterClass and managed topologies functionality.
Expand Down Expand Up @@ -72,7 +73,7 @@ func init() {
// To add a new feature, define a key for it above and add it here.
var defaultClusterAPIFeatureGates = map[featuregate.Feature]featuregate.FeatureSpec{
// Every feature should be initiated here:
ClusterResourceSet: {Default: true, PreRelease: featuregate.Beta},
ClusterResourceSet: {Default: true, PreRelease: featuregate.GA},
MachinePool: {Default: true, PreRelease: featuregate.Beta},
MachineSetPreflightChecks: {Default: true, PreRelease: featuregate.Beta},
ClusterTopology: {Default: false, PreRelease: featuregate.Alpha},
Expand Down

0 comments on commit a4fa5c8

Please sign in to comment.