From 56336e88926293c892d7da2804c5cea560ff9b3b Mon Sep 17 00:00:00 2001 From: Bogdan Socaciu Date: Thu, 26 Sep 2024 13:25:37 +0300 Subject: [PATCH] Fixed helm repo add. Added /tmp files to gitignore. Created missing make target. Updated Readme --- .gitignore | 1 + Makefile | 3 +++ README.md | 20 ++++---------------- hack/functions.sh | 2 +- 4 files changed, 9 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 892dd88b0..0d80e1790 100644 --- a/.gitignore +++ b/.gitignore @@ -84,3 +84,4 @@ bin/ testbin/ *-junit.xml .envrc +tmp/** \ No newline at end of file diff --git a/Makefile b/Makefile index c025c3824..542916b96 100644 --- a/Makefile +++ b/Makefile @@ -57,6 +57,9 @@ test: manifests generate fmt vet ginkgo ## Run tests. $(GINKGO) --label-filter=envtest -vv --no-color --procs 3 -output-dir=${PWD} -keep-separate-reports -race --junit-report=test-results-junit.xml --randomize-suites --randomize-all -timeout 10m ./... -covermode=count -coverprofile cover.out \ " +run-e2e-tests-local-kind: manifests generate fmt vet ## Run tests. + hack/run-e2e-using-kind.sh + ##@ Build build: generate fmt vet ## Build manager binary. diff --git a/README.md b/README.md index 3d127fe87..9826ab0bd 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ The Humio operator is a Kubernetes operator to automate provisioning, management ## Terminology -- CRD: Short for Custom Resource Definition. This is a way to extend the API of Kubernetes to allow new types of objects with clearly defined properties. -- CR: Custom Resource. Where CRD is the definition of the objects and their available properties, a CR is a specific instance of such an object. -- Controller and Operator: These are common terms within the Kubernetes ecosystem and they are implementations that take a defined desired state (e.g. from a CR of our HumioCluster CRD), and ensure the current state matches it. They typically includes what is called a reconciliation loop to help continuously ensuring the health of the system. -- Reconciliation loop: This is a term used for describing the loop running within controllers/operators to keep ensuring current state matches the desired state. +- **CRD**: Short for Custom Resource Definition. This is a way to extend the API of Kubernetes to allow new types of objects with clearly defined properties. +- **CR**: Custom Resource. Where CRD is the definition of the objects and their available properties, a CR is a specific instance of such an object. +- **Controller and Operator**: These are common terms within the Kubernetes ecosystem and they are implementations that take a defined desired state (e.g. from a CR of our HumioCluster CRD), and ensure the current state matches it. They typically includes what is called a reconciliation loop to help continuously ensuring the health of the system. +- **Reconciliation loop**: This is a term used for describing the loop running within controllers/operators to keep ensuring current state matches the desired state. ## Installation @@ -46,18 +46,6 @@ To run a E2E tests locally using `kind`, execute: make run-e2e-tests-local-kind ``` -We also have a script to start up `kind` cluster, deploy to it with Helm and spin up a basic Humio cluster: - -```bash -hack/test-helm-chart-kind.sh -``` - -To delete the `kind` cluster again, execute: - -```bash -hack/stop-kind-cluster.sh -``` - ## Publishing new releases In order to publish new release of the different components, we have the following procedures we can follow: diff --git a/hack/functions.sh b/hack/functions.sh index 027ae544c..ce0f5a1ed 100644 --- a/hack/functions.sh +++ b/hack/functions.sh @@ -225,7 +225,7 @@ helm_install_zookeeper_and_kafka() { $helm get metadata humio && return # Install test dependency: Zookeeper and Kafka - $helm repo add humio https://humio.github.io/cp-helm-charts + $helm repo add --force-update humio https://humio.github.io/cp-helm-charts helm_install_command=( $helm install humio humio/cp-helm-charts --set cp-zookeeper.servers=1