Skip to content

Commit

Permalink
chore: make docs match branch now that we are supporting versions
Browse files Browse the repository at this point in the history
Signed-off-by: zachaller <[email protected]>
  • Loading branch information
zachaller committed Feb 24, 2023
1 parent 9de54ae commit 9f6b0bd
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 263 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ kubectl argo rollouts dashboard [flags]

```
-h, --help help for dashboard
-p, --port int port to listen on (default 3100)
--root-path string changes the root path of the dashboard (default "rollouts")
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,36 @@ kubectl argo rollouts notifications [flags]
## Options

```
--as string Username to impersonate for the operation
--config-map string argo-rollouts-notification-configmap.yaml file path
-h, --help help for notifications
--password string Password for basic authentication to the API server
--proxy-url string If provided, this URL will be used to connect via proxy
--secret string argo-rollouts-notification-secret.yaml file path. Use empty secret if provided value is ':empty'
--username string Username for basic authentication to the API server
```

## Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--config-map string argo-rollouts-notification-configmap.yaml file path
--context string The name of the kubeconfig context to use
-h, --help help for notifications
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to a kube config. Only required if out-of-cluster
-v, --kloglevel int Log level for kubernetes client library
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--loglevel string Log level for kubectl argo rollouts (default "info")
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--proxy-url string If provided, this URL will be used to connect via proxy
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
--secret string argo-rollouts-notification-secret.yaml file path. Use empty secret if provided value is ':empty'
--server string The address and port of the Kubernetes API server
--tls-server-name string If provided, this name will be used to validate server certificate. If this is not provided, hostname used to contact the server is used.
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
```

## Options inherited from parent commands

```
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
-v, --kloglevel int Log level for kubernetes client library
--loglevel string Log level for kubectl argo rollouts (default "info")
```

## Available Commands
Expand Down
8 changes: 2 additions & 6 deletions docs/generated/notification-services/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,15 @@ metadata:
![](https://user-images.githubusercontent.com/18019529/108520497-168ce180-730e-11eb-93cb-b0b91f99bdc5.png)
If the message is set to 140 characters or more, it will be truncate.
```yaml
template.app-deployed: |
message: |
Application {{.app.metadata.name}} is now running new version of deployments manifests.
github:
repoURLPath: "{{.app.spec.source.repoURL}}"
revisionPath: "{{.app.status.operationState.syncResult.revision}}"
status:
state: success
label: "continuous-delivery/{{.app.metadata.name}}"
targetURL: "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true"
```
**Notes**:
- If the message is set to 140 characters or more, it will be truncated.
- If `github.repoURLPath` and `github.revisionPath` are same as above, they can be omitted.
15 changes: 2 additions & 13 deletions docs/generated/notification-services/googlechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can send [simple text](https://developers.google.com/chat/reference/message-
```yaml
template.app-sync-succeeded: |
message: The app {{ .app.metadata.name }} has successfully synced!
message: The app {{ .app.metadata.name }} has succesfully synced!
```
A card message can be defined as follows:
Expand All @@ -65,7 +65,7 @@ template.app-sync-succeeded: |
sections:
- widgets:
- textParagraph:
text: The app {{ .app.metadata.name }} has successfully synced!
text: The app {{ .app.metadata.name }} has succesfully synced!
- widgets:
- keyValue:
topLabel: Repository
Expand All @@ -79,14 +79,3 @@ template.app-sync-succeeded: |
```
The card message can be written in JSON too.
## Chat Threads
It is possible send both simple text and card messages in a chat thread by specifying a unique key for the thread. The thread key can be defined as follows:
```yaml
template.app-sync-succeeded: |
message: The app {{ .app.metadata.name }} has succesfully synced!
googlechat:
threadKey: {{ .app.metadata.name }}
```
61 changes: 0 additions & 61 deletions docs/generated/notification-services/newrelic.md

This file was deleted.

66 changes: 0 additions & 66 deletions docs/generated/notification-services/pagerduty.md

This file was deleted.

66 changes: 23 additions & 43 deletions docs/generated/notification-services/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,56 +29,36 @@ The Slack notification service configuration includes following settings:
1. Invite your slack bot to this channel **otherwise slack bot won't be able to deliver notifications to this channel**
1. Store Oauth access token in `argocd-notifications-secret` secret

```yaml
apiVersion: v1
kind: Secret
metadata:
```yaml
apiVersion: v1
kind: Secret
metadata:
name: <secret-name>
stringData:
stringData:
slack-token: <Oauth-access-token>
```
```
1. Define service type slack in data section of `argocd-notifications-cm` configmap:

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: <config-map-name>
data:
service.slack: |
token: $slack-token
```
service
```yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: <config-map-name>
data:
service.slack: |
token: $slack-token
```

1. Add annotation in application yaml file to enable notifications for specific argocd app

```yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
annotations:
notifications.argoproj.io/subscribe.on-sync-succeeded.slack: my_channel
```

1. Annotation with more than one trigger multiple of destinations and recipients

```yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
annotations:
notifications.argoproj.io/subscriptions: |
- trigger: [on-scaling-replica-set, on-rollout-updated, on-rollout-step-completed]
destinations:
- service: slack
recipients: [my-channel-1, my-channel-2]
- service: email
recipients: [recipient-1, recipient-2, recipient-3 ]
- trigger: [on-rollout-aborted, on-analysis-run-failed, on-analysis-run-error]
destinations:
- service: slack
recipients: [my-channel-21, my-channel-22]
```
```yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
annotations:
notifications.argoproj.io/subscribe.on-sync-succeeded.slack: my_channel
```

## Templates

Expand Down
41 changes: 0 additions & 41 deletions docs/generated/notification-services/webex.md

This file was deleted.

14 changes: 1 addition & 13 deletions docs/generated/notification-services/webhook.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
# Webhook
## Configuration

The webhook notification service allows sending a generic HTTP request using the templatized request body and URL.
Using Webhook you might trigger a Jenkins job, update Github commit status.

## Parameters

The Webhook notification service configuration includes following settings:

- `url` - the url to send the webhook to
- `headers` - optional, the headers to pass along with the webhook
- `basicAuth` - optional, the basic authentication to pass along with the webook
- `insecureSkipVerify` - optional bool, true or false

## Configuration

Use the following steps to configure webhook:

1 Register webhook in `argocd-notifications-cm` ConfigMap:
Expand All @@ -32,7 +21,6 @@ data:
basicAuth: #optional username password
username: <username>
password: <api-key>
insecureSkipVerify: true #optional bool
```
2 Define template that customizes webhook request method, path and body:
Expand Down

0 comments on commit 9f6b0bd

Please sign in to comment.