Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed helm repo add. Added /tmp files to gitignore. Created missing m… #859

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,4 @@ bin/
testbin/
*-junit.xml
.envrc
tmp/**
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
20 changes: 4 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion hack/functions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading