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.

Sign up for GitHub

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

chore(doc): Fix documentation Installation #106

Merged
merged 1 commit into from
Nov 5, 2024
Merged

chore(doc): Fix documentation Installation #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 7 additions & 5 deletions docs/getting-started/install.md
View file
Open in desktop
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
Loading