Skip to content

Commit

Permalink
Update plugin description and regen CRD YAML
Browse files Browse the repository at this point in the history
Signed-off-by: Jonathan West <[email protected]>
  • Loading branch information
jgwest committed Oct 16, 2024
1 parent 6bfa67b commit f36a278
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 2 deletions.
8 changes: 6 additions & 2 deletions api/v1alpha1/argorollouts_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,14 @@ type RolloutManagerSpec struct {
Plugins Plugins `json:"plugins,omitempty"`
}

// Plugin is used to integrate traffic management and metric plugins into the Argo Rollouts controller. For more information on these plugins, see the upstream Argo Rollouts documentation.
type Plugin struct {
Name string `json:"name"`
// Name of the plugin, it must match the name required by the plugin so it can find its configuration
Name string `json:"name"`
// Location supports http(s):// urls and file://, though file:// requires the plugin be available on the filesystem
Location string `json:"location"`
SHA256 string `json:"sha256,omitempty"`
// SHA256 is an optional sha256 checksum of the plugin executable
SHA256 string `json:"sha256,omitempty"`
}

type Plugins struct {
Expand Down
59 changes: 59 additions & 0 deletions bundle/manifests/argoproj.io_rolloutmanagers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,65 @@ spec:
type: object
type: array
type: object
plugins:
description: Plugins specify the traffic and metric plugins in Argo
Rollout
properties:
metric:
description: Metric holds a list of metric plugins used to gather
and report metrics during rollouts.
items:
description: Plugin is used to integrate traffic management
and metric plugins into the Argo Rollouts controller. For
more information on these plugins, see the upstream Argo Rollouts
documentation.
properties:
location:
description: Location supports http(s):// urls and file://,
though file:// requires the plugin be available on the
filesystem
type: string
name:
description: Name of the plugin, it must match the name
required by the plugin so it can find its configuration
type: string
sha256:
description: SHA256 is an optional sha256 checksum of the
plugin executable
type: string
required:
- location
- name
type: object
type: array
trafficManagement:
description: TrafficManagement holds a list of traffic management
plugins used to control traffic routing during rollouts.
items:
description: Plugin is used to integrate traffic management
and metric plugins into the Argo Rollouts controller. For
more information on these plugins, see the upstream Argo Rollouts
documentation.
properties:
location:
description: Location supports http(s):// urls and file://,
though file:// requires the plugin be available on the
filesystem
type: string
name:
description: Name of the plugin, it must match the name
required by the plugin so it can find its configuration
type: string
sha256:
description: SHA256 is an optional sha256 checksum of the
plugin executable
type: string
required:
- location
- name
type: object
type: array
type: object
skipNotificationSecretDeployment:
description: SkipNotificationSecretDeployment lets you specify if
the argo notification secret should be deployed
Expand Down
22 changes: 22 additions & 0 deletions config/crd/bases/argoproj.io_rolloutmanagers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -294,12 +294,23 @@ spec:
description: Metric holds a list of metric plugins used to gather
and report metrics during rollouts.
items:
description: Plugin is used to integrate traffic management
and metric plugins into the Argo Rollouts controller. For
more information on these plugins, see the upstream Argo Rollouts
documentation.
properties:
location:
description: Location supports http(s):// urls and file://,
though file:// requires the plugin be available on the
filesystem
type: string
name:
description: Name of the plugin, it must match the name
required by the plugin so it can find its configuration
type: string
sha256:
description: SHA256 is an optional sha256 checksum of the
plugin executable
type: string
required:
- location
Expand All @@ -310,12 +321,23 @@ spec:
description: TrafficManagement holds a list of traffic management
plugins used to control traffic routing during rollouts.
items:
description: Plugin is used to integrate traffic management
and metric plugins into the Argo Rollouts controller. For
more information on these plugins, see the upstream Argo Rollouts
documentation.
properties:
location:
description: Location supports http(s):// urls and file://,
though file:// requires the plugin be available on the
filesystem
type: string
name:
description: Name of the plugin, it must match the name
required by the plugin so it can find its configuration
type: string
sha256:
description: SHA256 is an optional sha256 checksum of the
plugin executable
type: string
required:
- location
Expand Down

0 comments on commit f36a278

Please sign in to comment.