diff --git a/crds/README.md b/crds/README.md deleted file mode 100644 index 542f90e..0000000 --- a/crds/README.md +++ /dev/null @@ -1,30 +0,0 @@ -## CRD's Schema
- - -Purpose: -The schema is meant to ease the use of CRDs by restricting the fields to defined types and providing relevant description. - - -### Work Flow - How add a new field: -* Not all steps are always required - -#### 1. Update Tags: -In the files -+ `pkg/apis/app/v1alpha1/redisenterprisedatabase_types.go`
-+ `pkg/apis/app/v1alpha1/redisenterprisecluster_types.go`
-add tags on top of variables to mark allowed types (Enum)
-(see: https://book.kubebuilder.io/reference/markers/crd-validation.html).
-They will be used by the operator sdk when creating the scheme.
-**Default values** do not appear in the schema since the operator has its own default mechanism. - - -#### 2 .Create the schema: -1) Install operator-sdk version 0.17.2.
-See: https://sdk.operatorframework.io/docs/installation/install-operator-sdk/#install-from-github-release -2) Run `operator-sdk generate crds` - -#### 3. Update the schema: -- Edit the current schema in all of the relevant CRD yamls with the new section that was generated
-- Note that fields which are k8s objects might be very long - e.g. `SideContainersSpec` -in this case -
it appears in the schema but with no description in the fields since it extends the schema and is not unique for Redis Enterprise. -