diff --git a/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_dashboard.md b/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_dashboard.md index d51cdb52c7..d8f8b40ac9 100644 --- a/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_dashboard.md +++ b/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_dashboard.md @@ -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") ``` diff --git a/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_notifications.md b/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_notifications.md index 72a7b4635b..1a8e8e736e 100644 --- a/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_notifications.md +++ b/docs/generated/kubectl-argo-rollouts/kubectl-argo-rollouts_notifications.md @@ -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 diff --git a/docs/generated/notification-services/github.md b/docs/generated/notification-services/github.md index 2b5bbf1e8c..953e55bd65 100755 --- a/docs/generated/notification-services/github.md +++ b/docs/generated/notification-services/github.md @@ -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. diff --git a/docs/generated/notification-services/googlechat.md b/docs/generated/notification-services/googlechat.md index 041ea6e022..0448469146 100755 --- a/docs/generated/notification-services/googlechat.md +++ b/docs/generated/notification-services/googlechat.md @@ -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: @@ -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 @@ -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 }} -``` diff --git a/docs/generated/notification-services/newrelic.md b/docs/generated/notification-services/newrelic.md deleted file mode 100755 index d98288a846..0000000000 --- a/docs/generated/notification-services/newrelic.md +++ /dev/null @@ -1,61 +0,0 @@ -# NewRelic - -## Parameters - -* `apiURL` - the api server url, e.g. https://api.newrelic.com -* `apiKey` - a [NewRelic ApiKey](https://docs.newrelic.com/docs/apis/rest-api-v2/get-started/introduction-new-relic-rest-api-v2/#api_key) - -## Configuration - -1. Create a NewRelic [Api Key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#user-api-key) -2. Store apiKey in `argocd-notifications-secret` Secret and configure NewRelic integration in `argocd-notifications-cm` ConfigMap - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: -data: - service.newrelic: | - apiURL: - apiKey: $newrelic-apiKey -``` - -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: -stringData: - newrelic-apiKey: apiKey -``` - -3. Copy [Application ID](https://docs.newrelic.com/docs/apis/rest-api-v2/get-started/get-app-other-ids-new-relic-one/#apm) -4. Create subscription for your NewRelic integration - -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Application -metadata: - annotations: - notifications.argoproj.io/subscribe..newrelic: -``` - -## Templates - -* `description` - __optional__, high-level description of this deployment, visible in the [Summary](https://docs.newrelic.com/docs/apm/applications-menu/monitoring/apm-overview-page) page and on the [Deployments](https://docs.newrelic.com/docs/apm/applications-menu/events/deployments-page) page when you select an individual deployment. - * Defaults to `message` -* `changelog` - __optional__, A summary of what changed in this deployment, visible in the [Deployments](https://docs.newrelic.com/docs/apm/applications-menu/events/deployments-page) page when you select (selected deployment) > Change log. - * Defaults to `{{(call .repo.GetCommitMetadata .app.status.sync.revision).Message}}` -* `user` - __optional__, A username to associate with the deployment, visible in the [Summary](https://docs.newrelic.com/docs/apm/applications-menu/events/deployments-page) and on the [Deployments](https://docs.newrelic.com/docs/apm/applications-menu/events/deployments-page). - * Defaults to `{{(call .repo.GetCommitMetadata .app.status.sync.revision).Author}}` - -```yaml -context: | - argocdUrl: https://example.com/argocd - -template.app-deployed: | - message: Application {{.app.metadata.name}} has successfully deployed. - newrelic: - description: Application {{.app.metadata.name}} has successfully deployed -``` diff --git a/docs/generated/notification-services/pagerduty.md b/docs/generated/notification-services/pagerduty.md deleted file mode 100755 index 849b4db802..0000000000 --- a/docs/generated/notification-services/pagerduty.md +++ /dev/null @@ -1,66 +0,0 @@ -# Pagerduty - -## Parameters - -The Pagerduty notification service is used to create pagerduty incidents and requires specifying the following settings: - -* `pagerdutyToken` - the pagerduty auth token -* `from` - email address of a valid user associated with the account making the request. -* `serviceID` - The ID of the resource. - - -## Example - -The following snippet contains sample Pagerduty service configuration: - -```yaml -apiVersion: v1 -kind: Secret -metadata: - name: -stringData: - pagerdutyToken: -``` - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: -data: - service.pagerduty: | - token: $pagerdutyToken - from: -``` - -## Template - -Notification templates support specifying subject for pagerduty notifications: - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: -data: - template.rollout-aborted: | - message: Rollout {{.rollout.metadata.name}} is aborted. - pagerduty: - title: "Rollout {{.rollout.metadata.name}}" - urgency: "high" - body: "Rollout {{.rollout.metadata.name}} aborted " - priorityID: "" -``` - -NOTE: A Priority is a label representing the importance and impact of an incident. This is only available on Standard and Enterprise plans of pagerduty. - -## Annotation - -Annotation sample for pagerduty notifications: -```yaml -apiVersion: argoproj.io/v1alpha1 -kind: Rollout -metadata: - annotations: - notifications.argoproj.io/subscribe.on-rollout-aborted.pagerduty: "" -``` \ No newline at end of file diff --git a/docs/generated/notification-services/slack.md b/docs/generated/notification-services/slack.md index 0cd9a0f177..04d5633a5f 100755 --- a/docs/generated/notification-services/slack.md +++ b/docs/generated/notification-services/slack.md @@ -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: - stringData: + stringData: slack-token: -``` + ``` 1. Define service type slack in data section of `argocd-notifications-cm` configmap: - -```yaml - apiVersion: v1 - kind: ConfigMap - metadata: - name: - data: - service.slack: | - token: $slack-token -``` +service + ```yaml + apiVersion: v1 + kind: ConfigMap + metadata: + 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 diff --git a/docs/generated/notification-services/webex.md b/docs/generated/notification-services/webex.md deleted file mode 100755 index 440ed1ddc7..0000000000 --- a/docs/generated/notification-services/webex.md +++ /dev/null @@ -1,41 +0,0 @@ -# Webex Teams - -## Parameters - -The Webex Teams notification service configuration includes following settings: - -* `token` - the app token - -## Configuration - -1. Create a Webex [Bot](https://developer.webex.com/docs/bots) -1. Copy the bot access [token](https://developer.webex.com/my-apps) and store it in the `argocd-notifications-secret` Secret and configure Webex Teams integration in `argocd-notifications-cm` ConfigMap - - ``` yaml - apiVersion: v1 - kind: Secret - metadata: - name: - stringData: - webex-token: - ``` - - ``` yaml - apiVersion: v1 - kind: ConfigMap - metadata: - name: - data: - service.webex: | - token: $webex-token - ``` - -1. Create subscription for your Webex Teams integration - - ``` yaml - apiVersion: argoproj.io/v1alpha1 - kind: Application - metadata: - annotations: - notifications.argoproj.io/subscribe..webex: - ``` diff --git a/docs/generated/notification-services/webhook.md b/docs/generated/notification-services/webhook.md index bd45b1f69e..b6aee1ea7d 100755 --- a/docs/generated/notification-services/webhook.md +++ b/docs/generated/notification-services/webhook.md @@ -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: @@ -32,7 +21,6 @@ data: basicAuth: #optional username password username: password: - insecureSkipVerify: true #optional bool ``` 2 Define template that customizes webhook request method, path and body: