Final pre-release changes (devfile#47)

* maintainers updated Signed-off-by: Michael Valdron <[email protected]> * set version to 0.1.0 maturity beta Signed-off-by: Michael Valdron <[email protected]> * csv manifest updated descriptions for CRs Signed-off-by: Michael Valdron <[email protected]> * correct invalid namespace test case label for ClusterDevfileRegistriesList CR webhook Signed-off-by: Michael Valdron <[email protected]> * CR descriptions updated in source. Signed-off-by: Michael Valdron <[email protected]> * bundle and manifest updates generated Signed-off-by: Michael Valdron <[email protected]> * devfileregistry CR description updated Signed-off-by: Michael Valdron <[email protected]> * update samples of ClusterDevfileRegistriesList and DevfileRegistriesList CRs Signed-off-by: Michael Valdron <[email protected]> * Updates to CRDs and CSV Signed-off-by: Michael Valdron <[email protected]> * License and CONTRIBUTING.md links added to README Signed-off-by: Michael Valdron <[email protected]> * Update description and capabilities Signed-off-by: Michael Valdron <[email protected]> * update bundle files Signed-off-by: Michael Valdron <[email protected]> * update to new devfile icon Signed-off-by: Michael Valdron <[email protected]> * update display name Signed-off-by: Michael Valdron <[email protected]> * update devfileregistry sample Signed-off-by: Michael Valdron <[email protected]> * fix links for pull requests Signed-off-by: Michael Valdron <[email protected]> * update CHANGELOG Signed-off-by: Michael Valdron <[email protected]> * documentation review revisions Co-authored-by: Philippe Martin <[email protected]> Signed-off-by: Michael Valdron <[email protected]> * fix formatting of devfileregistry_types.go Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]> Co-authored-by: Philippe Martin <[email protected]> Signed-off-by: thepetk <[email protected]>
thepetk · Aug 20, 2024 · f9388e2 · f9388e2
1 parent 04739cf
commit f9388e2
Show file tree

Hide file tree

Showing 20 changed files with 579 additions and 55 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,13 +9,13 @@ Fixes #?
 **PR acceptance criteria**:
 
 - [ ] Change Log
-    - Are all your changes documented under the [upcoming release](../CHANGELOG.md#unreleased) entry?
+    - Are all your changes documented under the [upcoming release](https://github.com/devfile/registry-operator/tree/main/CHANGELOG.md#unreleased) entry?
 - [ ] Test Coverage 
     - Are your changes sufficiently tested, and are any applicable test cases added or updated to cover your changes?
 - [ ] Gosec scans 
   - Fix all MEDIUM and higher findings and/or annotate a finding per gosec instructions: https://github.com/securego/gosec#annotating-code to address why a finding is not a security issue
 
 Documentation
-- [ ] Does the [registry operator documentation](https://github.com/devfile/devfile-web/tree/main/libs/docs/src/docs/no-version) need to updated with your changes?
+- [ ] Does the registry operator documentation need to be updated with your changes?
 
 **How to test changes / Special notes to the reviewer**:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,24 +5,61 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
-
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.1.0]
+
 ### Added
 - [devfile/api#1106](https://github.com/devfile/api/issues/1106)
   Registry operator should be in sync with operator SDK releases
   - Addition of `CHANGELOG.md`
+- [devfile/api#1233](https://github.com/devfile/api/issues/1233)
+  - Included `install-cert` as an required step before `install` and `deploy`
 
 ### Changed
-
+- [devfile/api#1233](https://github.com/devfile/api/issues/1233)
+  Update CONTRIBUTING for registry operator
+  - Replaced prerequisites with a reference to the [requirements section](README.md#requirements) under the README
+- [devfile/api#1211](https://github.com/devfile/api/issues/1211)
+  Devfile registry operator pre-release to OperatorHub
+  - Bump version to `v0.1.0`
+  - Changes to CRs, CRDs, samples, and CSV to provide up to date information on the operator
+    - Metadata
+      - Capabilities
+      - Categories
+      - Container Image
+      - Source Repository Link
+      - Maintainer Organization
+      - Samples List
+      - Short Description
+    - Maintainers List
+    - Icon
+    - Display Name
+    - Long Description
+    - Version
+  - Update [README](README.md) with [LICENSE](LICENSE) and [CONTRIBUTING.md](CONTRIBUTING.md) links
 - [devfile/api#1106](https://github.com/devfile/api/issues/1106)
   Registry operator should be in sync with operator SDK releases
   - Syncs changes up to operator sdk v1.28
     - [v1.28.0 changes](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.28.0/)
     - [v1.25.0 changes](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.25.0/)
     - [v1.23.0 changes](https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.23.0/)
+- [devfile/api#1015](https://github.com/devfile/api/issues/1015)
+  Complete documentation coverage of registry operator
+  - Provided complete documentation on makefile usage
+  - Provided complete documentation on deployment spec fields
 - [devfile/api#881](https://github.com/devfile/api/issues/881)
   Update Ginkgo version in registry operator
 
 ### Fixed
 - [devfile/api#1106](https://github.com/devfile/api/issues/1106)
   Registry operator should be in sync with operator SDK releases
   - Registry operator service account changed from `default` to `service-account` to fix permissions error for creating leader election leases
+- [devfile/api#1211](https://github.com/devfile/api/issues/1211)
+  Devfile registry operator pre-release to OperatorHub
+  - Fixes for links under [PR template](.github/PULL_REQUEST_TEMPLATE.md)
diff --git a/DEVFILE_REGISTRY.md b/DEVFILE_REGISTRY.md
@@ -1,10 +1,12 @@
 # Devfile Registry
 
-The Devfile Registry custom resource allows you to create and manage your own index server and registry viewer.
+DevfileRegistry is a custom resource allowing you to create and manage your own index server and registry viewer. In order to be added, the 
+Devfile Registry must be reachable, must support the Devfile v2.0 spec and above, and cannot be deployed to the default namespace.
 
 ## Deploying a Devfile Registry
 
-Once the Devfile Registry operator has been deployed to a cluster, you can deploy a Devfile Registry by creating custom resources. The following samples below showcase how the registry can be deployed on to an OpenShift or Kubernetes cluster.
+Once the Devfile Registry operator has been deployed to a cluster, you can deploy a Devfile Registry by creating custom resources. The following 
+samples below showcase how the registry can be deployed on to an OpenShift or Kubernetes cluster.
 
 In addition to the examples below, the `samples/` folder in this repo provides some example devfile registry yaml files for convenience.
 

diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
 
 # Devfile Registry Operator
 
+<div id="header">
+
+[![Apache2.0 License](https://img.shields.io/badge/license-Apache2.0-brightgreen.svg)](LICENSE)
+</div>
+
 The Devfile Registry operator manages the lifecycle of the following custom resources:
 1. [Devfile Registry](DEVFILE_REGISTRY.md)
 2. [Devfile Registries List](REGISTRIES_LISTS.md)
@@ -126,4 +131,8 @@ make install
 
 ```bash
 make run ENABLE_WEBHOOKS=false
-```
+```
+
+## Contributing
+
+Please see our [contributing.md](./CONTRIBUTING.md).
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.0.1
+0.1.0
diff --git a/api/v1alpha1/clusterdevfileregistrieslist_types.go b/api/v1alpha1/clusterdevfileregistrieslist_types.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2022 Red Hat, Inc.
+Copyright 2022-2023 Red Hat, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -26,7 +26,8 @@ import (
 // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.status",description="The status for the Cluster Devfile Registries List"
 
 // ClusterDevfileRegistriesList is a custom resource where cluster admins can add a list of Devfile Registries to allow devfiles to be visible
-// at the cluster level.  In order to be added to the list, the Devfile Registries must be reachable and support the Devfile v2.0 spec and above.
+// at the cluster level.  In order to be added to the list, the Devfile Registries must be reachable, supports the Devfile v2.0 spec and above,
+// and is not using the default namespace.
 type ClusterDevfileRegistriesList struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/clusterdevfileregistrieslist_webhook_test.go b/api/v1alpha1/clusterdevfileregistrieslist_webhook_test.go
@@ -37,7 +37,7 @@ var _ = Describe("ClusterDevfileRegistriesList validation webhook", func() {
 		})
 	})
 
-	Context("Create ClusterDevfileRegistriesList CR with valid values", func() {
+	Context("Create ClusterDevfileRegistriesList CR in forbidden default namespaces", func() {
 		It("Should fail to create a new CR in the default namespace", func() {
 			ctx := context.Background()
 			Expect(k8sClient.Create(ctx, getClusterDevfileRegistriesListCR("default-namespace-list", "default",

diff --git a/api/v1alpha1/devfileregistrieslist_types.go b/api/v1alpha1/devfileregistrieslist_types.go
@@ -1,5 +1,5 @@
 /*
-Copyright 2022 Red Hat, Inc.
+Copyright 2022-2023 Red Hat, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -57,7 +57,8 @@ type DevfileRegistriesListStatus struct {
 // +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.status",description="The status for the Devfile Registries List"
 
 // DevfileRegistriesList is a custom resource where namespace users can add a list of Devfile Registries to allow devfiles to be visible
-// at the namespace level.  In order to be added to the list, the Devfile Registries must be reachable and support the Devfile v2.0 spec and above.
+// at the namespace level.  In order to be added to the list, the Devfile Registries must be reachable, supports the Devfile v2.0 spec
+// and above, and is not using the default namespace.
 type DevfileRegistriesList struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

diff --git a/api/v1alpha1/devfileregistry_types.go b/api/v1alpha1/devfileregistry_types.go
@@ -128,7 +128,9 @@ type DevfileRegistryStatus struct {
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 
-// DevfileRegistry is the Schema for the devfileregistries API
+// DevfileRegistry is a custom resource allows you to create and manage your own index server and registry viewer.
+// In order to be added, the Devfile Registry must be reachable, supports the Devfile v2.0 spec and above, and is
+// not using the default namespace.
 // +kubebuilder:resource:path=devfileregistries,shortName=devreg;dr
 // +kubebuilder:subresource:status
 // +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".status.url",description="The URL for the Devfile Registry"

diff --git a/bundle/manifests/registry-operator.clusterserviceversion.yaml b/bundle/manifests/registry-operator.clusterserviceversion.yaml
diff --git a/bundle/manifests/registry.devfile.io_clusterdevfileregistrieslists.yaml b/bundle/manifests/registry.devfile.io_clusterdevfileregistrieslists.yaml
@@ -36,7 +36,8 @@ spec:
         description: ClusterDevfileRegistriesList is a custom resource where cluster
           admins can add a list of Devfile Registries to allow devfiles to be visible
           at the cluster level.  In order to be added to the list, the Devfile Registries
-          must be reachable and support the Devfile v2.0 spec and above.
+          must be reachable, supports the Devfile v2.0 spec and above, and is not
+          using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/bundle/manifests/registry.devfile.io_devfileregistries.yaml b/bundle/manifests/registry.devfile.io_devfileregistries.yaml
@@ -25,7 +25,10 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: DevfileRegistry is the Schema for the devfileregistries API
+        description: DevfileRegistry is a custom resource allows you to create and
+          manage your own index server and registry viewer. In order to be added,
+          the Devfile Registry must be reachable, supports the Devfile v2.0 spec and
+          above, and is not using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/bundle/manifests/registry.devfile.io_devfileregistrieslists.yaml b/bundle/manifests/registry.devfile.io_devfileregistrieslists.yaml
@@ -36,7 +36,8 @@ spec:
         description: DevfileRegistriesList is a custom resource where namespace users
           can add a list of Devfile Registries to allow devfiles to be visible at
           the namespace level.  In order to be added to the list, the Devfile Registries
-          must be reachable and support the Devfile v2.0 spec and above.
+          must be reachable, supports the Devfile v2.0 spec and above, and is not
+          using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/config/crd/bases/registry.devfile.io_clusterdevfileregistrieslists.yaml b/config/crd/bases/registry.devfile.io_clusterdevfileregistrieslists.yaml
@@ -26,7 +26,8 @@ spec:
         description: ClusterDevfileRegistriesList is a custom resource where cluster
           admins can add a list of Devfile Registries to allow devfiles to be visible
           at the cluster level.  In order to be added to the list, the Devfile Registries
-          must be reachable and support the Devfile v2.0 spec and above.
+          must be reachable, supports the Devfile v2.0 spec and above, and is not
+          using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/config/crd/bases/registry.devfile.io_devfileregistries.yaml b/config/crd/bases/registry.devfile.io_devfileregistries.yaml
@@ -26,7 +26,10 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: DevfileRegistry is the Schema for the devfileregistries API
+        description: DevfileRegistry is a custom resource allows you to create and
+          manage your own index server and registry viewer. In order to be added,
+          the Devfile Registry must be reachable, supports the Devfile v2.0 spec and
+          above, and is not using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/config/crd/bases/registry.devfile.io_devfileregistrieslists.yaml b/config/crd/bases/registry.devfile.io_devfileregistrieslists.yaml
@@ -26,7 +26,8 @@ spec:
         description: DevfileRegistriesList is a custom resource where namespace users
           can add a list of Devfile Registries to allow devfiles to be visible at
           the namespace level.  In order to be added to the list, the Devfile Registries
-          must be reachable and support the Devfile v2.0 spec and above.
+          must be reachable, supports the Devfile v2.0 spec and above, and is not
+          using the default namespace.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/config/manifests/bases/registry-operator.clusterserviceversion.yaml b/config/manifests/bases/registry-operator.clusterserviceversion.yaml
diff --git a/config/samples/registry_v1alpha1_clusterdevfileregistrieslist.yaml b/config/samples/registry_v1alpha1_clusterdevfileregistrieslist.yaml
@@ -1,6 +1,8 @@
 apiVersion: registry.devfile.io/v1alpha1
-kind: clusterDevfileRegistriesList
+kind: ClusterDevfileRegistriesList
 metadata:
-  name: clusterdevfileregistrieslist-sample
+  name: sample-clusterdevfileregistrieslist
 spec:
-  # TODO(user): Add fields here
+  devfileRegistries:
+    - name: devfile-staging
+      url: https://registry.stage.devfile.io
diff --git a/config/samples/registry_v1alpha1_devfileregistrieslist.yaml b/config/samples/registry_v1alpha1_devfileregistrieslist.yaml
@@ -1,6 +1,8 @@
 apiVersion: registry.devfile.io/v1alpha1
 kind: DevfileRegistriesList
 metadata:
-  name: devfileregistrieslist-sample
+  name: sample-devfileregistrieslist
 spec:
-  # TODO(user): Add fields here
+  devfileRegistries:
+    - name: devfile-staging
+      url: https://registry.stage.devfile.io
diff --git a/config/samples/registry_v1alpha1_devfileregistry.yaml b/config/samples/registry_v1alpha1_devfileregistry.yaml
@@ -3,4 +3,5 @@ kind: DevfileRegistry
 metadata:
   name: sample-devfileregistry
 spec:
-  devfileIndexImage: quay.io/devfile/devfile-index:next
+  devfileIndex: 
+    image: quay.io/devfile/devfile-index:next