forked from argoproj/argo-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request argoproj#14 from blackrock/mmagaldi
cleaning up artifact related documentation
- Loading branch information
Showing
7 changed files
with
230 additions
and
674 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,8 @@ | ||
# Artifact Guide | ||
`Sensors` supports S3 artifact repositories. To take advantage of these artifact signals, you can use this guide to get started with installing artifact services. | ||
|
||
### Prerequisites | ||
Up & Running kubernetes instance | ||
`Sensors` support S3 artifact notifications. To take advantage of these artifact signals, you can use this guide to get started with installing artifact services. | ||
|
||
## Minio | ||
[Minio](https://www.minio.io/) is an distributed object storage server. | ||
|
||
### Install | ||
``` | ||
$ brew install kubernetes-helm # mac | ||
$ helm init | ||
$ helm repo add stable https://kubernetes-charts.storage.googleapis.com | ||
$ helm repo update | ||
$ helm install stable/minio --name artifacts --set service.type=LoadBalancer | ||
$ helm upgrade -f docs/minio-config.yaml stable/minio | ||
``` | ||
[Minio](https://www.minio.io/) is an distributed object storage server. Follow the Minio [Bucket Notification Guide](https://docs.minio.io/docs/minio-bucket-notification-guide) for help with configuring your minio server to listen and monitor for bucket event notifications. Note that you will need an `Axis` supported message queue up and running as a prerequisite for configuring your notification targets (i.e. NATS, WebHooks, Kafka, etc.). | ||
|
||
Note: When minio is installed via Helm, it uses the following hard-wired default credentials and creates a kubernetes secret with a hash of these keys. Signal specifications rely on kubernetes secrets instead of the raw keys. | ||
- AccessKey: AKIAIOSFODNN7EXAMPLE | ||
- SecretKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY | ||
### Enabling bucket notifications | ||
Once the Minio server is configured with a notification target and you have restarted the server to put the changes into effect, you now need to explicitely enable event notifications for a specified bucket. Enabling these notifications are out of scope of `Axis` since bucket notifications are a construct within Minio that exists at the `bucket` level. This means that if `Axis` was responsible for the lifecycle of the bucket notifications, multiple sensors on the same S3 bucket would conflict with eachother. Thus, creating, updating, and deleting the Minio bucket notifications should be delegated to a separate process with knowledge of all notification targets including those outside of the `Axis` project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.