Skip to content

Commit

Permalink
Update remaining v1alpha1 references with v1 (#1452)
Browse files Browse the repository at this point in the history
There are a few remaining references to v1alpha1 that need to be
updated to use v1.

Ref:
* #1228

Signed-off-by: Mikalai Radchuk <[email protected]>
  • Loading branch information
m1kola authored Nov 13, 2024
1 parent a5966fa commit 102f29f
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion api/v1/groupversion_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion config/samples/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
## Append samples of your project ##
resources:
- olm_v1_clusterextension.yaml
- olm_v1alpha1_extension.yaml
#+kubebuilder:scaffold:manifestskustomizesamples
2 changes: 1 addition & 1 deletion docs/api-reference/operator-controller-api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/olmv1_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/howto/derive-service-account.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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):

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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).

0 comments on commit 102f29f

Please sign in to comment.