diff --git a/README.md b/README.md index 81d9203764..2b6a2bee0d 100644 --- a/README.md +++ b/README.md @@ -152,33 +152,6 @@ kubectl annotate ns keptn.sh/lifecycle-toolkit='enabled Please be aware that, if this option is set, adding any additional namespace requires the helm installation to be updated by adding the name of the new namespace to the list. -### Installation without scheduler - -Keptn installed on Kubernetes cluster running Kubernetes >= 1.26 -does not need scheduler for a proper functionality. -With introduction -of [Pod scheduling gates](https://kubernetes.io/blog/2022/12/26/pod-scheduling-readiness-alpha/) -Keptn can use this feature to substitute the functionality of Keptn scheduler. - -As this functionality is still disabled by default, it can be enabled by setting up -the correct helm values. -This will lead to a Keptn installation without a scheduler and -with scheduling gates feature enabled. - -Use the following command sequence -to install Keptn with scheduling gates enabled: - -```shell -helm repo add keptn https://charts.lifecycle.keptn.sh -helm repo update -helm upgrade --install keptn keptn/keptn -n keptn-system --set schedulingGatesEnabled=true --create-namespace --wait -``` - -> **Note** -Please be aware that scheduling gates functionality in Kubernetes is enabled by default -in Kubernetes >= 1.27. -To use it with Kubernetes 1.26, you need to enable it on your cluster. - ## More information For more info about Keptn, please see our @@ -320,28 +293,15 @@ the plugin verifies that the pre deployment checks have terminated by retrieving the current status of the WorkloadInstance. Only when that is successful is the pod bound to a node. -## Install a dev build - -The [GitHub CLI](https://cli.github.com/) can be used to download the manifests of the latest CI build. +## Contributing -```bash -gh run list --repo keptn/lifecycle-toolkit # find the id of a run -gh run download 3152895000 --repo keptn/lifecycle-toolkit # download the artifacts -kubectl apply -f ./keptn-lifecycle-operator-manifest/release.yaml # install the lifecycle-operator -kubectl apply -f ./scheduler-manifest/release.yaml # install the scheduler -``` - -Instead, if you want to build and deploy the operator into your cluster -directly from the code, you can type: +For more information about contributing to Keptn, please +refer to the [Contribution guide](https://keptn.sh/stable/docs/contribute/) +section of the documentation. -```bash -RELEASE_REGISTRY= -# (optional)ARCH= -# (optional)CHART_APPVERSION= - -# Build and deploy the dev images to the current kubernetes cluster -make build-deploy-dev-environment -``` +To set up your local Keptn development environment, please follow +[these steps](https://keptn.sh/stable/docs/contribute/software/dev-environ/#first-steps) +for new contributors. ## License diff --git a/docs/docs/contribute/software/dev-environ.md b/docs/docs/contribute/software/dev-environ.md index 2fee2139ca..aed36da0cb 100644 --- a/docs/docs/contribute/software/dev-environ.md +++ b/docs/docs/contribute/software/dev-environ.md @@ -98,11 +98,13 @@ you need to install the following on your system: on your Kubernetes cluster and pushes the built image to your private repository. You identify your private repository with the `RELEASE_REGISTRY=` argument and can add any `TAG` arguments you like. + You can also specify the architecture by setting the `ARCH` argument, + which is set to `amd64` by default. For example, the following command builds the environment and pushes the image to the `docker.io/exampleuser` DockerHub repository: ```shell -make build-deploy-dev-environment RELEASE_REGISTRY=docker.io/exampleuser TAG=main +make build-deploy-dev-environment RELEASE_REGISTRY=docker.io/exampleuser TAG=main ARCH=arm64 ``` The build commands are defined in the