Skip to content

Commit

Permalink
docs(readme): change documentation link to argo-watcher.readthedocs.io (
Browse files Browse the repository at this point in the history
  • Loading branch information
shini4i authored Sep 30, 2023
1 parent c5d5f2b commit 8819c28
Showing 1 changed file with 2 additions and 28 deletions.
30 changes: 2 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Enhancing Deployment Visibility with Argo CD Image Updater & Direct GitOps Repos
![GitHub release (latest by date)](https://img.shields.io/github/v/release/shini4i/argo-watcher)
[![codecov](https://codecov.io/gh/shini4i/argo-watcher/graph/badge.svg?token=9JI19X0BIN)](https://codecov.io/gh/shini4i/argo-watcher)
[![Go Report Card](https://goreportcard.com/badge/github.com/shini4i/argo-watcher)](https://goreportcard.com/report/github.com/shini4i/argo-watcher)
[![Documentation Status](https://readthedocs.org/projects/argo-watcher/badge/?version=latest)](https://argo-watcher.readthedocs.io/en/latest/?badge=latest)
![GitHub](https://img.shields.io/github/license/shini4i/argo-watcher)

<img src="https://raw.githubusercontent.com/shini4i/assets/main/src/argo-watcher/demo.png" alt="Showcase" height="441" width="620">
Expand Down Expand Up @@ -60,34 +61,7 @@ graph TD

## Documentation

> Starting with version v0.6.0, Argo Watcher now offers experimental support for making direct commits to the GitOps repository.
<details>
<summary>Direct Git Integration</summary>
If you've been using Argo CD Image Updater across hundreds of applications, you might have noticed that the latency in detecting new images can sometimes slow down your deployments considerably.

To address the challenges with deployment latency, we're excited to unveil an experimental feature in Argo Watcher that allows direct commits to your GitOps repository.

We remain committed to supporting the straightforward scenario where users simply check the Application status. This ensures flexibility for those who prefer or need to use the original method.

For those looking to experiment with faster image updates, you can leverage the new direct commit capability using the following annotations.

```yaml
annotations:
argo-watcher/managed: "true"
argo-watcher/managed-images: "app=ghcr.io/shini4i/argo-watcher"
argo-watcher/app.helm.image-tag: "image.tag"
```
This configuration will require mounting ssh key to the container. Support for this configuration is available in helm chart starting from verion `0.4.0`.

⚠️ Important Note Regarding Direct Commit Feature:

Please be aware that when using the direct commit feature, Argo Watcher does not verify the actual availability of the image. It assumes and trusts that the tag received from the client is correct. Ensure you have processes in place to validate image tags before relying on this feature.
</details>

- Installation instructions and more information can be found in the [docs](docs/installation.md).
- Development instructions can be found in the [docs](docs/development.md).
- A short story about why this project was created can be found [here](https://medium.com/dyninno/a-journey-to-gitops-9aa445474eb6).
The up to date documentation is available on the [readthedocs.io](https://argo-watcher.readthedocs.io).

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

0 comments on commit 8819c28

Please sign in to comment.