Skip to content

Commit

Permalink
chore(doc): Fix documentation Installation (#106)
Browse files Browse the repository at this point in the history
Co-authored-by: David MICHENEAU <david.micheneau@orange.com>
  • Loading branch information
dmicheneau and David MICHENEAU authored Nov 5, 2024
1 parent b7c78c8 commit 362ea2c
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ Kimup Operator is a Kubernetes operator used to manage images and their lifecycl

Resources managed by Kimup Operator are:

* [Image](crd/image.md)
* [AlertConfig](crd/alertconfig.md)
* [Kimup](crd/kimup.md)
* [Image](../crd/image.md)
* [AlertConfig](../crd/alertconfig.md)
* [Kimup](../crd/kimup.md)

## Prerequisites

* A Kubernetes cluster with a version >= 1.19
* A Kubernetes cluster with a version >= 1.28
* `kubectl` with kustomize installed and configured to connect to your cluster
* `cert-manager` installed in your cluster (See [cert-manager documentation](https://cert-manager.io/docs/installation/kubernetes/))

## Installation

Expand All @@ -39,7 +40,7 @@ By default, Kimup Operator is installed in the `kimup-operator` namespace.

### Deploy `kimup-controller`

For deploying `kimup-controller`, create a `Kimup` resource:
For deploying `kimup-controller`, create a `Kimup` resource in the `kimup-operator` namespace:

```yaml
apiVersion: kimup.cloudavenue.io/v1alpha1
Expand All @@ -48,6 +49,7 @@ metadata:
labels:
app.kubernetes.io/name: kube-image-updater
name: kimup
namespace: kimup-operator
spec:
name: demo
logLevel: info
Expand Down

0 comments on commit 362ea2c

Please sign in to comment.