From 0e8f717162d551314b0c12bc522bab3469004136 Mon Sep 17 00:00:00 2001 From: Kyriakos Akriotis Date: Sat, 7 Dec 2024 08:32:03 +0100 Subject: [PATCH] bump images and chart version, changes in README.md #2 --- Makefile | 4 ++-- README.md | 32 +++++++++++++-------------- charts/typesense-operator/Chart.yaml | 4 ++-- charts/typesense-operator/values.yaml | 2 +- config/samples/kustomization.yaml | 1 + 5 files changed, 22 insertions(+), 21 deletions(-) diff --git a/Makefile b/Makefile index e91ef83..591cb15 100644 --- a/Makefile +++ b/Makefile @@ -50,9 +50,9 @@ endif # This is useful for CI or a project to utilize a specific version of the operator-sdk toolkit. OPERATOR_SDK_VERSION ?= v1.38.0 # Image URL to use all building/pushing image targets -DOCKER_HUB_NAME ?= akyriako78# $(shell docker info | sed '/Username:/!d;s/.* //') +DOCKER_HUB_NAME ?= $(shell docker info | sed '/Username:/!d;s/.* //') IMG_NAME ?= typesense-operator -IMG_TAG ?= 0.1.1-dev.3 +IMG_TAG ?= 0.2.0-rc.0 IMG ?= $(DOCKER_HUB_NAME)/$(IMG_NAME):$(IMG_TAG) # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. diff --git a/README.md b/README.md index 3776c8d..6fb0d40 100644 --- a/README.md +++ b/README.md @@ -174,7 +174,7 @@ You’ll need a Kubernetes cluster to run against. You can use [KIND](https://si ### Deploy Using Helm -On the other hand if you are deploying on a production environment, it is **highly recommended** to deploy the +If you are deploying on a production environment, it is **highly recommended** to deploy the controller to the cluster using a **Helm chart** from its repo: ```sh @@ -202,19 +202,24 @@ make deploy IMG=/typesense-operator: 3. Install Instances of Custom Resources: -If you are running on KIND, first install a custom storage class required by the samples +Provision one of the samples available in `config/samples`: -```shell -kubectl apply -f config/kind/ -``` - -and then the samples: +| Suffix | Description | CSI Driver | Storage Class | +|---------------|--------------------|--------------------------------------------|-----------------------| +| | Generic | | standard | +| azure | Microsoft Azure | disk.csi.azure.com | managed-csi | +| aws | AWS | ebs.csi.aws.com | gp2 | +| opentelekomcloud | Open Telekom Cloud | disk.csi.everest.io
obs.csi.everest.io | csi-disk
csi-obs | +| bm | Bare Metal | democratic-csi (iscsi/nfs) | iscsi
nfs | +| kind | KiND | | rancher.io/local-path | ```sh -kubectl apply -f config/samples/ +kubectl apply -f config/samples/ts_v1alpha1_typesensecluster_{{Suffix}} ``` -```yaml +e.g. for AWS looks like: + +```yaml title=ts_v1alpha1_typesensecluster_aws.yaml apiVersion: ts.opentelekomcloud.com/v1alpha1 kind: TypesenseCluster metadata: @@ -226,15 +231,10 @@ spec: image: typesense/typesense:27.1 replicas: 3 storage: - size: 10Mi - storageClassName: typesense-local-path + size: 100Mi + storageClassName: gp2 ``` -> [!CAUTION] -> - The samples are tailored for KIND, change the `storageClassName` value according to your target environment. -> - The 3rd sample is designed to portray a failing installation, `storageClassName` is set to `iscsi` which will fail on -> any Kubernetes cluster that is not using [democratic-csi](https://github.com/democratic-csi/democratic-csi). - #### Uninstall CRDs To delete the CRDs from the cluster: diff --git a/charts/typesense-operator/Chart.yaml b/charts/typesense-operator/Chart.yaml index 90d8c1b..c7f6473 100644 --- a/charts/typesense-operator/Chart.yaml +++ b/charts/typesense-operator/Chart.yaml @@ -13,9 +13,9 @@ type: application # This is the chart version. This version number should be incremented each time you make changes # to the chart and its templates, including the app version. # Versions are expected to follow Semantic Versioning (https://semver.org/) -version: 0.1.0 +version: 0.2.0 # This is the version number of the application being deployed. This version number should be # incremented each time you make changes to the application. Versions are not expected to # follow Semantic Versioning. They should reflect the version the application is using. # It is recommended to use it with quotes. -appVersion: "0.1.0" +appVersion: "0.2.0-rc.0" diff --git a/charts/typesense-operator/values.yaml b/charts/typesense-operator/values.yaml index ab48682..030818e 100644 --- a/charts/typesense-operator/values.yaml +++ b/charts/typesense-operator/values.yaml @@ -12,7 +12,7 @@ controllerManager: - ALL image: repository: akyriako78/typesense-operator - tag: 0.1.1-dev.3 + tag: 0.2.0-rc.0 resources: limits: cpu: 500m diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml index 16a8190..b461735 100644 --- a/config/samples/kustomization.yaml +++ b/config/samples/kustomization.yaml @@ -5,4 +5,5 @@ resources: - ts_v1alpha1_typesensecluster_bm.yaml - ts_v1alpha1_typesensecluster_kind.yaml - ts_v1alpha1_typesensecluster_opentelekomcloud.yaml +- ts_v1alpha1_typesensecluster.yaml # +kubebuilder:scaffold:manifestskustomizesamples