Skip to content

Commit

Permalink
chore: Add Doc (#17)
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 committed Oct 1, 2024
1 parent 082422b commit 1fe4544
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ config/manifests/mutatingWebhookConfiguration.yaml
site/
**/charts/**
config/manifests/deployments.yaml
site/
19 changes: 19 additions & 0 deletions docs/howto.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<<<<<<< HEAD
---
hide:
- toc
---

=======
>>>>>>> e2a5d09 (chore: Add Doc (#17))
# HowTo

## How to Use
Expand Down Expand Up @@ -36,7 +39,10 @@ spec:
```bash
kubectl apply -f image.yaml
```
<<<<<<< HEAD

=======
>>>>>>> e2a5d09 (chore: Add Doc (#17))
In this example the image `ghcr.io/orange-cloudavenue/kube-image-updater` will be updated every 12 hours with the latest minor version.

3 - Check the Image TAG:
Expand All @@ -45,9 +51,14 @@ In this example the image `ghcr.io/orange-cloudavenue/kube-image-updater` will b
kubectl get image demo'
NAME IMAGE TAG
<<<<<<< HEAD
demo ghcr.io/azrod/golink
```

=======
demo ghcr.io/azrod/golink
```
>>>>>>> e2a5d09 (chore: Add Doc (#17))
But you can force the update by running the following command:

```bash
Expand Down Expand Up @@ -76,8 +87,11 @@ spec:
app: golink
template:
metadata:
<<<<<<< HEAD
annotations:
kimup.cloudavenue.io/enabled: "true"
=======
>>>>>>> e2a5d09 (chore: Add Doc (#17))
labels:
app: golink
spec:
Expand All @@ -95,3 +109,8 @@ kubectl apply -f deployment.yaml
```

Now the deployment is running with the image `ghcr.io/azrod/golink:v0.1.0` define by your rules in the CRD `Image`.
<<<<<<< HEAD
=======


>>>>>>> e2a5d09 (chore: Add Doc (#17))
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ Type of **Actions**:
- **refresh**: Apply the new image to the resource.
- **notify**: Notify a webhook with the new image.(Not implemented yet)
- **request-approval**: Request approval to apply the new image.(Not implemented yet)
<<<<<<< HEAD
=======

>>>>>>> e2a5d09 (chore: Add Doc (#17))
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,11 @@ nav:
- Getting Started:
- Installation: install.md
- Howto: howto.md
<<<<<<< HEAD
- Custom Resources:
- Image: crd/image.md
=======
>>>>>>> e2a5d09 (chore: Add Doc (#17))

markdown_extensions:
# Python Markdown
Expand Down

0 comments on commit 1fe4544

Please sign in to comment.