Automate catalog item creation (#213)

* update: exclude spellcheck on INFO.md

* add: generate operator files script

* refactor: ack-controllers

* refactor: opendatahub operator

* refactor: nfd operator

* refactor: openshift-gitops-operator

* refactor: serverless operator

* fix: README path

* fix: script linting

* refactor: gitops operator

* update: volsync

* refactor: volsync

* fix: linting

* update: web terminal

* remove: old files

* fix: bases to resources

* remove: old files

* update: openshift-gitops-operator

* update: README.md bases to resources

* update: bases to resources

* update: cleanup whitespace

* update: cleanup

* update: odh, nfd, serverless

* update: rename rhods to redhat-ods

* update: ods file names

* update: ods

* add:  operator_info.txt

* fix: ods

* update: serverless

* update: scripts

* update: rename folders to operator name

* fix: README, script

* update: script for better markdown

* update: better markdown lint

* fix: more markdown

* fix: markdown info

* rename: base files

* update: files to operator-group.yaml

* update: rename filename namespace.yaml

* update: rename filename subscription.yaml

* update: rename filename namespace.yaml

* fix: wordlist

* undo: markdown code snippet

* cleanup: nmstate

* cleanup: s3 operator

* update: info, script

* cleanup: patchesJson6902

* update: cleanup acm

* update: cleanup filenames

* fix: rhods operator

* fix: logic

* update: wordlist

* fix: linting

Author: codekow

.spellcheck.yaml

@@ -15,5 +15,5 @@ matrix:
             - code
             - pre
     sources:
-      - '!venv/**|**/*.md'
+      - '!**/INFO.md|!venv/**|**/*.md'
     default_encoding: utf-8

.wordlist-md

@@ -50,7 +50,7 @@ Noobaa
 NuGet
 OADP
 OAuth
-OCSInitilization
+OCSInitialization
 OLM
 Observability
 OpenDataHub
@@ -86,6 +86,7 @@ UI
 VolSync
 Workspaces
 ack
+acm
 amq
 api
 apiVersion
@@ -186,7 +187,7 @@ sublicense
 tekton
 templating
 thanos
-truely
+truly
 vSphere
 vsphere
 workspaces

CONTRIBUTING.md

@@ -21,7 +21,7 @@ In general, the root folder should represent the functionality being provided wi
 
 Overlays for operators should generally use the `channel` name as the name of the overlay if multiple channels are available. For example, if the channel names are `tech-preview` and `stable` then name the overlays the same corresponding to the channels.
 
-When adding new objects into an example, avoid combining objects into a single yaml file.  Each object should have its own yaml file that is referenced as a resource in the `kustomization.yaml` file.  Some exceptions may exist, such as combining `role` and `roleBinding` into a single RBAC file.  
+When adding new objects into an example, avoid combining objects into a single yaml file.  Each object should have its own yaml file that is referenced as a resource in the `kustomization.yaml` file.  Some exceptions may exist, such as combining `role` and `roleBinding` into a single RBAC file.
 
 Files in this repository should use the `.yaml` extension and not `.yml`.  Kustomize files should utilize `kustomization.yaml` over alternative naming options.
 

README.md

@@ -6,9 +6,13 @@ The GitOps Catalog includes kustomize bases and overlays for a number of OpenShi
 
 This catalog is not officially supported by Red Hat and customers are discouraged from referencing this repo directly as a remote repo in kustomize as future changes may break these references. Instead customers are encouraged to take individual items of interest into their own curated catalog and maintain it as their own.
 
+See [Operator Info](operator_info.txt) for a detailed list of dumped OpenShift operator info.
+
 ## Catalog Refactoring for Consistency
 
-Now that this catalog is part of the Red Hat Community of Practice, there will be some structural refactoring to improve consistency.  If you have been using this catalog since before it was part of the `redhat-cop` organization, or at least before any refactoring has begun, be sure to include a `ref` in your `oc/kubectl` commands or `kustomization.yaml` files to avoid any negative side effects.  The last tag before the repository was migrated is `v0.3`.  Simply include `?ref=v0.3` at the end of the repository reference.  For example:
+Now that this catalog is part of the Red Hat Community of Practice, there will be some structural refactoring to improve consistency.  If you have been using this catalog since before it was part of the `redhat-cop` organization, or at least before any refactoring has begun, be sure to include a `ref` in your `oc/kubectl` commands or `kustomization.yaml` files to avoid any negative side effects.  The last tag before the repository was migrated is `v0.3`.  Simply include `?ref=v0.3` at the end of the repository reference.  
+
+For example:
 
 ```
 oc apply -k https://github.com/redhat-cop/gitops-catalog/jenkins2/overlays/default?ref=v0.3
@@ -24,7 +28,6 @@ resources:
 - github.com/redhat-cop/gitops-catalog/jenkins2/base/?ref=v0.3
 ```
 
-
 ## Usage
 
 Each catalog item has (or will have) its own README in its directory root with instructions.  Generally speaking, you can usually just apply a "base" or "overlay" directly in your cluster by cloning this repository and using the `-k` flag (for Kustomize) built into `oc` and `kubectl`:
@@ -56,3 +59,12 @@ resources:
 
 This enables you to patch these resources for your specific environments. Note that none of these bases specify a namespace, in your kustomization
 overlay you can include the specific namespace you want to install the tool into.
+
+## Development
+
+You can use the following to help you create the basic structure for an operator.
+
+```
+# load functions
+source scripts/automate_operators.sh
+```

ack-controllers/aggregate/popular/kustomization.yaml

@@ -26,6 +26,6 @@ As part of a different overlay in your own GitOps repo:
 ```
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
-bases:
+resources:
   - github.com/redhat-cop/gitops-catalog/ack-ec2-controller/operator/overlays/<channel>?ref=main
 ```

ack-ec2-controller/README.md

@@ -1,8 +1,6 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
-bases:
-  - ../../ack-controllers/base
-
 resources:
-  - install.yaml
+  - ../../../ack-system/base
+  - subscription.yaml

ack-s3-controller/base/kustomization.yaml renamed to ack-ec2-controller/operator/base/kustomization.yaml

@@ -1,13 +1,10 @@
----
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
-  labels:
-    operators.coreos.com/ack-ec2-controller.ack-system: ""
   name: ack-ec2-controller
   namespace: ack-system
 spec:
-  channel: patch-me
+  channel: patch-me-see-overlays-dir
   installPlanApproval: Automatic
   name: ack-ec2-controller
   source: community-operators

ack-ec2-controller/base/install.yaml renamed to ack-ec2-controller/operator/base/subscription.yaml

@@ -2,7 +2,7 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
-bases:
+resources:
   - ../../base
 
 patches: