From 0aa25b5ef71035c592beef71b942005f45d9da83 Mon Sep 17 00:00:00 2001 From: Mikalai Radchuk Date: Wed, 13 Nov 2024 12:07:30 +0100 Subject: [PATCH] Update remaining v1alpha1 references with v1 There are a few remaining references to v1alpha1 that need to be updated to use v1. Ref: * https://github.com/operator-framework/operator-controller/pull/1228 Signed-off-by: Mikalai Radchuk --- api/v1/groupversion_info.go | 2 +- config/samples/kustomization.yaml | 1 - .../api-reference/operator-controller-api-reference.md | 2 +- docs/getting-started/olmv1_getting_started.md | 2 +- docs/howto/derive-service-account.md | 10 +++++----- 5 files changed, 8 insertions(+), 9 deletions(-) diff --git a/api/v1/groupversion_info.go b/api/v1/groupversion_info.go index fdd9174ac..f2e8582ee 100644 --- a/api/v1/groupversion_info.go +++ b/api/v1/groupversion_info.go @@ -14,7 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Package v1alpha1 contains API Schema definitions for the olm v1alpha1 API group +// Package v1 contains API Schema definitions for the olm v1 API group // +kubebuilder:object:generate=true // +groupName=olm.operatorframework.io package v1 diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml index 7816e8fef..2a64d96c2 100644 --- a/config/samples/kustomization.yaml +++ b/config/samples/kustomization.yaml @@ -1,5 +1,4 @@ ## Append samples of your project ## resources: - olm_v1_clusterextension.yaml -- olm_v1alpha1_extension.yaml #+kubebuilder:scaffold:manifestskustomizesamples diff --git a/docs/api-reference/operator-controller-api-reference.md b/docs/api-reference/operator-controller-api-reference.md index 63ea96df6..c3a3862b1 100644 --- a/docs/api-reference/operator-controller-api-reference.md +++ b/docs/api-reference/operator-controller-api-reference.md @@ -6,7 +6,7 @@ ## olm.operatorframework.io/v1 -Package v1alpha1 contains API Schema definitions for the olm v1alpha1 API group +Package v1 contains API Schema definitions for the olm v1 API group ### Resource Types - [ClusterExtension](#clusterextension) diff --git a/docs/getting-started/olmv1_getting_started.md b/docs/getting-started/olmv1_getting_started.md index 49ec4a137..444a43e47 100644 --- a/docs/getting-started/olmv1_getting_started.md +++ b/docs/getting-started/olmv1_getting_started.md @@ -65,7 +65,7 @@ More information on installing extensions can be found [here](../tutorials/insta ```bash # Apply the sample ClusterExtension. Manifest already includes # namespace and adequately privileged service account -kubectl apply -f https://raw.githubusercontent.com/operator-framework/operator-controller/main/config/samples/olm_v1alpha1_clusterextension.yaml +kubectl apply -f https://raw.githubusercontent.com/operator-framework/operator-controller/main/config/samples/olm_v1_clusterextension.yaml ``` ### Upgrade the Cluster Extension diff --git a/docs/howto/derive-service-account.md b/docs/howto/derive-service-account.md index ac0481ffc..08ce67929 100644 --- a/docs/howto/derive-service-account.md +++ b/docs/howto/derive-service-account.md @@ -1,6 +1,6 @@ # Derive minimal ServiceAccount required for ClusterExtension Installation and Management -OLM v1 does not have permission to install extensions on a cluster by default. In order to install a [supported bundle](../project/olmv1_limitations.md), +OLM v1 does not have permission to install extensions on a cluster by default. In order to install a [supported bundle](../project/olmv1_limitations.md), OLM must be provided a ServiceAccount configured with the appropriate permissions. This document serves as a guide for how to derive the RBAC necessary to install a bundle. @@ -31,7 +31,7 @@ Depending on the scope, each permission will need to be added to either a `Clust ### Example The following example illustrates the process of deriving the minimal RBAC required to install the [ArgoCD Operator](https://operatorhub.io/operator/argocd-operator) [v0.6.0](https://operatorhub.io/operator/argocd-operator/alpha/argocd-operator.v0.6.0) provided by [OperatorHub.io](https://operatorhub.io/). -The final permission set can be found in the [ClusterExtension sample manifest](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1alpha1_clusterextension.yaml) in the [samples](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1alpha1_clusterextension.yaml) directory. +The final permission set can be found in the [ClusterExtension sample manifest](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1_clusterextension.yaml) in the [samples](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1_clusterextension.yaml) directory. The bundle includes the following manifests, which can be found [here](https://github.com/argoproj-labs/argocd-operator/tree/da6b8a7e68f71920de9545152714b9066990fc4b/deploy/olm-catalog/argocd-operator/0.6.0): @@ -99,7 +99,7 @@ The same can be done for `ClusterRoleBindings`. ##### Step 2. `CustomResourceDefinition` permissions -The installer service account must be able to create and manage the `CustomResourceDefinition`s for the extension, as well +The installer service account must be able to create and manage the `CustomResourceDefinition`s for the extension, as well as grant the extension controller's service account the permissions it needs to manage its CRDs. ```yaml @@ -302,7 +302,7 @@ Once the installer service account required cluster-scoped and namespace-scoped 6. Create the `RoleBinding` between the installer service account and its role 7. Create the `ClusterExtension` -A manifest with the full set of resources can be found [here](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1alpha1_clusterextension.yaml). +A manifest with the full set of resources can be found [here](https://github.com/operator-framework/operator-controller/blob/main/config/samples/olm_v1_clusterextension.yaml). ### Alternatives @@ -348,5 +348,5 @@ kubectl create clusterrolebinding my-cluster-extension-installer-role-binding \ In the spirit of making this process more tenable until the proper tools are in place, the scripts in [hack/tools/catalogs](https://github.com/operator-framework/operator-controller/blob/main/hack/tools/catalogs) were created to help the user navigate and search catalogs as well -as to generate the minimal RBAC requirements. These tools are offered as is, with no guarantees on their correctness, +as to generate the minimal RBAC requirements. These tools are offered as is, with no guarantees on their correctness, support, or maintenance. For more information, see [Hack Catalog Tools](https://github.com/operator-framework/operator-controller/blob/main/hack/tools/catalogs/README.md).