Skip to content

Commit

Permalink
fix: build
Browse files Browse the repository at this point in the history
  • Loading branch information
davidebianchi committed Aug 15, 2024
1 parent 338fb1a commit 1a12c0e
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Check the [API reference](apireference_v1alpha1.md) for the SleepInfo CRD to und
Patches are used to define how to change the resources so that the runtime will "sleep". The patches are applied to the resources at the sleep time and are reverted at the wake up time.

In this way, it is possible to support all the Kubernetes resources, also the ones defined through the custom resource definitions.
<!-- TODO: anchor in html not seen. Use markdown anchor in template -->
To let *kube-green* support a custom resource, you need to define the specific `patch` for the resource inside the `SleepInfo` (the API reference is available [here](apireference_v1alpha1.md#kube-green.com/v1alpha1.Patch)) and add the permission to the ClusterRole associated to the *kube-green* manager ([here how to configure the RBAC](./installation/rbac.md)), if not already set.

## Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Try our tutorials to get started. Are available [here](tutorials/kind.md).
## Install

To start using kube-green, you need to install it in a kubernetes cluster.
[Click here](install.md) to see how to install.
[Click here](./installation/index.md) to see how to install.

## Create and deploy SleepInfo

Expand Down
8 changes: 4 additions & 4 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/downlo

## Getting started

* [`kubectl apply`](./install.md#kubectl-apply): install using kubectl apply and static manifest;
* [`helm`](./install.md#helm-chart): install *kube-green* using the helm chart; this allows to customize the installation if necessary;
* [`Operator Lifecycle Manager (OLM)`](./install.md#operator-lifecycle-manager-olm): it's possible to install *kube-green* with OperatorHub or, if you use OpenShift, with the OpenShift web console;
* [`kustomize`](./install.md#kustomize): in the *kube-green* GitHub repository are available the kustomize configuration. In this way, it's possible to release the development version and configure it editing the files.
* [kubectl apply](./install.md#kubectl-apply): install using kubectl apply and static manifest;
* [helm](./install.md#helm-chart): install *kube-green* using the helm chart; this allows to customize the installation if necessary;
* [Operator Lifecycle Manager (OLM)](./install.md#operator-lifecycle-manager-olm): it's possible to install *kube-green* with OperatorHub or, if you use OpenShift, with the OpenShift web console;
* [kustomize](./install.md#kustomize): in the *kube-green* GitHub repository are available the kustomize configuration. In this way, it's possible to release the development version and configure it editing the files.
2 changes: 1 addition & 1 deletion docs/tutorials/kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ kubectl -n cert-manager get pods

## Install kube-green

Install *kube-green* with default static install. [Click here](../install.md) to see the different install methods supported.
Install *kube-green* with default static install. [Click here](../installation/index.md) to see the different install methods supported.

Install *kube-green* with this command:

Expand Down

0 comments on commit 1a12c0e

Please sign in to comment.