Rename "auto" subcommands to "image"

This means all the sub-subcommands can drop the `image-` prefix,
making them shorter and more fluent.

E.g.,

    flux create image policy

rather than

    flux create auto image-policy

Signed-off-by: Michael Bridgen <michael@weave.works>
pull/538/head
Michael Bridgen 4 years ago
parent 22a5ac7f0f
commit 45240bdb71

@ -22,18 +22,17 @@ import (
"github.com/spf13/cobra"
)
const createAutoLong = `
The create auto sub-cmmands works with automation objects; that is,
const createImageLong = `
The create image sub-commands work with image automation objects; that is,
object controlling updates to git based on e.g., new container images
being available.`
var createAutoCmd = &cobra.Command{
Use: "auto",
Aliases: []string{"automation"},
Short: "Create or update resources dealing with automation",
Long: strings.TrimSpace(createAutoLong),
var createImageCmd = &cobra.Command{
Use: "image",
Short: "Create or update resources dealing with image automation",
Long: strings.TrimSpace(createImageLong),
}
func init() {
createCmd.AddCommand(createAutoCmd)
createCmd.AddCommand(createImageCmd)
}

@ -34,16 +34,16 @@ import (
"github.com/fluxcd/pkg/apis/meta"
)
var createAutoImagePolicyCmd = &cobra.Command{
Use: "image-policy <name>",
var createImagePolicyCmd = &cobra.Command{
Use: "policy <name>",
Short: "Create or update an ImagePolicy object",
Long: `The create auto image-policy command generates an ImagePolicy resource.
Long: `The create image policy command generates an ImagePolicy resource.
An ImagePolicy object calculates a "latest image" given an image
repository and a policy, e.g., semver.
The image that sorts highest according to the policy is recorded in
the status of the object.`,
RunE: createAutoImagePolicyRun}
RunE: createImagePolicyRun}
type imagePolicyFlags struct {
imageRef string
@ -53,14 +53,14 @@ type imagePolicyFlags struct {
var imagePolicyArgs = imagePolicyFlags{}
func init() {
flags := createAutoImagePolicyCmd.Flags()
flags := createImagePolicyCmd.Flags()
flags.StringVar(&imagePolicyArgs.imageRef, "image-ref", "", "the name of an image repository object")
flags.StringVar(&imagePolicyArgs.semver, "semver", "", "a semver range to apply to tags; e.g., '1.x'")
createAutoCmd.AddCommand(createAutoImagePolicyCmd)
createImageCmd.AddCommand(createImagePolicyCmd)
}
func createAutoImagePolicyRun(cmd *cobra.Command, args []string) error {
func createImagePolicyRun(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return fmt.Errorf("ImagePolicy name is required")
}

@ -36,12 +36,12 @@ import (
"github.com/fluxcd/pkg/apis/meta"
)
var createAutoImageRepositoryCmd = &cobra.Command{
Use: "image-repository <name>",
var createImageRepositoryCmd = &cobra.Command{
Use: "repository <name>",
Short: "Create or update an ImageRepository object",
Long: `The create auto image-repository command generates an ImageRepository resource.
Long: `The create image repository command generates an ImageRepository resource.
An ImageRepository object specifies an image repository to scan.`,
RunE: createAutoImageRepositoryRun,
RunE: createImageRepositoryRun,
}
type imageRepoFlags struct {
@ -53,17 +53,17 @@ type imageRepoFlags struct {
var imageRepoArgs = imageRepoFlags{}
func init() {
flags := createAutoImageRepositoryCmd.Flags()
flags := createImageRepositoryCmd.Flags()
flags.StringVar(&imageRepoArgs.image, "image", "", "the image repository to scan; e.g., library/alpine")
flags.StringVar(&imageRepoArgs.secretRef, "secret-ref", "", "the name of a docker-registry secret to use for credentials")
// NB there is already a --timeout in the global flags, for
// controlling timeout on operations while e.g., creating objects.
flags.DurationVar(&imageRepoArgs.timeout, "scan-timeout", 0, "a timeout for scanning; this defaults to the interval if not set")
createAutoCmd.AddCommand(createAutoImageRepositoryCmd)
createImageCmd.AddCommand(createImageRepositoryCmd)
}
func createAutoImageRepositoryRun(cmd *cobra.Command, args []string) error {
func createImageRepositoryRun(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return fmt.Errorf("ImageRepository name is required")
}

@ -34,13 +34,13 @@ import (
"github.com/fluxcd/pkg/apis/meta"
)
var createAutoImageUpdateCmd = &cobra.Command{
Use: "image-update <name>",
var createImageUpdateCmd = &cobra.Command{
Use: "update <name>",
Short: "Create or update an ImageUpdateAutomation object",
Long: `The create auto image-update command generates an ImageUpdateAutomation resource.
Long: `The create image update command generates an ImageUpdateAutomation resource.
An ImageUpdateAutomation object specifies an automated update to images
mentioned in YAMLs in a git repository.`,
RunE: createAutoImageUpdateRun,
RunE: createImageUpdateRun,
}
type imageUpdateFlags struct {
@ -56,17 +56,17 @@ type imageUpdateFlags struct {
var imageUpdateArgs = imageUpdateFlags{}
func init() {
flags := createAutoImageUpdateCmd.Flags()
flags := createImageUpdateCmd.Flags()
flags.StringVar(&imageUpdateArgs.gitRepoRef, "git-repo-ref", "", "the name of a GitRepository resource with details of the upstream git repository")
flags.StringVar(&imageUpdateArgs.branch, "branch", "", "the branch to push commits to")
flags.StringVar(&imageUpdateArgs.commitTemplate, "commit-template", "", "a template for commit messages")
flags.StringVar(&imageUpdateArgs.authorName, "author-name", "", "the name to use for commit author")
flags.StringVar(&imageUpdateArgs.authorEmail, "author-email", "", "the email to use for commit author")
createAutoCmd.AddCommand(createAutoImageUpdateCmd)
createImageCmd.AddCommand(createImageUpdateCmd)
}
func createAutoImageUpdateRun(cmd *cobra.Command, args []string) error {
func createImageUpdateRun(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return fmt.Errorf("ImageUpdateAutomation name is required")
}

@ -20,12 +20,12 @@ import (
"github.com/spf13/cobra"
)
var getAutoCmd = &cobra.Command{
Use: "auto",
Short: "Get automation statuses",
Long: "The get auto sub-commands print the statuses of the automation objects.",
var exportImageCmd = &cobra.Command{
Use: "image",
Short: "Export image automation objects",
Long: "The export image sub-commands export image automation objects in YAML format.",
}
func init() {
getCmd.AddCommand(getAutoCmd)
exportCmd.AddCommand(exportImageCmd)
}

@ -24,14 +24,14 @@ import (
)
var exportImagePolicyCmd = &cobra.Command{
Use: "image-policy [name]",
Use: "policy [name]",
Short: "Export ImagePolicy resources in YAML format",
Long: "The export image-policy command exports one or all ImagePolicy resources in YAML format.",
Long: "The export image policy command exports one or all ImagePolicy resources in YAML format.",
Example: ` # Export all ImagePolicy resources
flux export auto image-policy --all > image-policies.yaml
flux export image policy --all > image-policies.yaml
# Export a specific policy
flux export auto image-policy alpine1x > alpine1x.yaml
flux export image policy alpine1x > alpine1x.yaml
`,
RunE: exportCommand{
object: imagePolicyAdapter{&imagev1.ImagePolicy{}},
@ -40,7 +40,7 @@ var exportImagePolicyCmd = &cobra.Command{
}
func init() {
exportAutoCmd.AddCommand(exportImagePolicyCmd)
exportImageCmd.AddCommand(exportImagePolicyCmd)
}
// Export returns a ImagePolicy value which has extraneous information

@ -24,14 +24,14 @@ import (
)
var exportImageRepositoryCmd = &cobra.Command{
Use: "image-repository [name]",
Use: "repository [name]",
Short: "Export ImageRepository resources in YAML format",
Long: "The export image-repository command exports one or all ImageRepository resources in YAML format.",
Long: "The export image repository command exports one or all ImageRepository resources in YAML format.",
Example: ` # Export all ImageRepository resources
flux export auto image-repository --all > image-repositories.yaml
flux export image repository --all > image-repositories.yaml
# Export a Provider
flux export auto image-repository alpine > alpine.yaml
# Export a specific ImageRepository resource
flux export image repository alpine > alpine.yaml
`,
RunE: exportCommand{
object: imageRepositoryAdapter{&imagev1.ImageRepository{}},
@ -40,7 +40,7 @@ var exportImageRepositoryCmd = &cobra.Command{
}
func init() {
exportAutoCmd.AddCommand(exportImageRepositoryCmd)
exportImageCmd.AddCommand(exportImageRepositoryCmd)
}
func exportImageRepository(repo *imagev1.ImageRepository) interface{} {

@ -24,14 +24,14 @@ import (
)
var exportImageUpdateCmd = &cobra.Command{
Use: "image-update [name]",
Use: "update [name]",
Short: "Export ImageUpdateAutomation resources in YAML format",
Long: "The export image-update command exports one or all ImageUpdateAutomation resources in YAML format.",
Long: "The export image update command exports one or all ImageUpdateAutomation resources in YAML format.",
Example: ` # Export all ImageUpdateAutomation resources
flux export auto image-update --all > updates.yaml
flux export image update --all > updates.yaml
# Export a specific automation
flux export auto image-update latest-images > latest.yaml
flux export image update latest-images > latest.yaml
`,
RunE: exportCommand{
object: imageUpdateAutomationAdapter{&autov1.ImageUpdateAutomation{}},
@ -40,7 +40,7 @@ var exportImageUpdateCmd = &cobra.Command{
}
func init() {
exportAutoCmd.AddCommand(exportImageUpdateCmd)
exportImageCmd.AddCommand(exportImageUpdateCmd)
}
// exportImageUpdate returns a value which has extraneous information

@ -20,12 +20,12 @@ import (
"github.com/spf13/cobra"
)
var resumeAutoCmd = &cobra.Command{
Use: "auto",
Short: "Resume automation objects",
Long: "The resume auto sub-commands resume a suspended automation object.",
var getImageCmd = &cobra.Command{
Use: "image",
Short: "Get image automation object status",
Long: "The get image sub-commands print the status of image automation objects.",
}
func init() {
resumeCmd.AddCommand(resumeAutoCmd)
getCmd.AddCommand(getImageCmd)
}

@ -23,14 +23,14 @@ import (
)
var getImagePolicyCmd = &cobra.Command{
Use: "image-policy",
Short: "Get ImagePolicy statuses",
Long: "The get auto image-policy command prints the status of ImagePolicy objects.",
Use: "policy",
Short: "Get ImagePolicy status",
Long: "The get image policy command prints the status of ImagePolicy objects.",
Example: ` # List all image policies and their status
flux get auto image-policy
flux get image policy
# List image policies from all namespaces
flux get auto image-policy --all-namespaces
flux get image policy --all-namespaces
`,
RunE: getCommand{
names: imagePolicyNames,
@ -39,7 +39,7 @@ var getImagePolicyCmd = &cobra.Command{
}
func init() {
getAutoCmd.AddCommand(getImagePolicyCmd)
getImageCmd.AddCommand(getImagePolicyCmd)
}
func (s imagePolicyListAdapter) summariseItem(i int, includeNamespace bool) []string {

@ -27,14 +27,14 @@ import (
)
var getImageRepositoryCmd = &cobra.Command{
Use: "image-repository",
Short: "Get ImageRepository statuses",
Long: "The get auto image-repository command prints the status of ImageRepository objects.",
Use: "repository",
Short: "Get ImageRepository status",
Long: "The get image repository command prints the status of ImageRepository objects.",
Example: ` # List all image repositories and their status
flux get auto image-repository
flux get image repository
# List image repositories from all namespaces
flux get auto image-repository --all-namespaces
flux get image repository --all-namespaces
`,
RunE: getCommand{
names: imageRepositoryNames,
@ -43,7 +43,7 @@ var getImageRepositoryCmd = &cobra.Command{
}
func init() {
getAutoCmd.AddCommand(getImageRepositoryCmd)
getImageCmd.AddCommand(getImageRepositoryCmd)
}
func (s imageRepositoryListAdapter) summariseItem(i int, includeNamespace bool) []string {

@ -27,14 +27,14 @@ import (
)
var getImageUpdateCmd = &cobra.Command{
Use: "image-update",
Short: "Get ImageUpdateAutomation statuses",
Long: "The get auto image-update command prints the status of ImageUpdateAutomation objects.",
Use: "update",
Short: "Get ImageUpdateAutomation status",
Long: "The get image update command prints the status of ImageUpdateAutomation objects.",
Example: ` # List all image update automation object and their status
flux get auto image-update
flux get image update
# List image update automations from all namespaces
flux get auto image-update --all-namespaces
flux get image update --all-namespaces
`,
RunE: getCommand{
names: imageUpdateAutomationNames,
@ -43,7 +43,7 @@ var getImageUpdateCmd = &cobra.Command{
}
func init() {
getAutoCmd.AddCommand(getImageUpdateCmd)
getImageCmd.AddCommand(getImageUpdateCmd)
}
func (s imageUpdateAutomationListAdapter) summariseItem(i int, includeNamespace bool) []string {

@ -20,12 +20,12 @@ import (
"github.com/spf13/cobra"
)
var reconcileAutoCmd = &cobra.Command{
Use: "auto",
Short: "Reconcile automation objects",
Long: "The reconcile auto sub-commands trigger a reconciliation of automation objects.",
var reconcileImageCmd = &cobra.Command{
Use: "image",
Short: "Reconcile image automation objects",
Long: "The reconcile sub-commands trigger a reconciliation of image automation objects.",
}
func init() {
reconcileCmd.AddCommand(reconcileAutoCmd)
reconcileCmd.AddCommand(reconcileImageCmd)
}

@ -25,11 +25,11 @@ import (
)
var reconcileImageRepositoryCmd = &cobra.Command{
Use: "image-repository [name]",
Use: "repository [name]",
Short: "Reconcile an ImageRepository",
Long: `The reconcile auto image-repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.`,
Long: `The reconcile image repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.`,
Example: ` # Trigger an scan for an existing image repository
flux reconcile auto image-repository alpine
flux reconcile image repository alpine
`,
RunE: reconcileCommand{
names: imageRepositoryNames,
@ -38,7 +38,7 @@ var reconcileImageRepositoryCmd = &cobra.Command{
}
func init() {
reconcileAutoCmd.AddCommand(reconcileImageRepositoryCmd)
reconcileImageCmd.AddCommand(reconcileImageRepositoryCmd)
}
func (obj imageRepositoryAdapter) lastHandledReconcileRequest() string {

@ -27,11 +27,11 @@ import (
)
var reconcileImageUpdateCmd = &cobra.Command{
Use: "image-update [name]",
Use: "update [name]",
Short: "Reconcile an ImageUpdateAutomation",
Long: `The reconcile auto image-update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.`,
Long: `The reconcile image update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.`,
Example: ` # Trigger an automation run for an existing image update automation
flux reconcile auto image-update latest-images
flux reconcile image update latest-images
`,
RunE: reconcileCommand{
names: imageUpdateAutomationNames,
@ -40,7 +40,7 @@ var reconcileImageUpdateCmd = &cobra.Command{
}
func init() {
reconcileAutoCmd.AddCommand(reconcileImageUpdateCmd)
reconcileImageCmd.AddCommand(reconcileImageUpdateCmd)
}
func (obj imageUpdateAutomationAdapter) suspended() bool {

@ -20,12 +20,12 @@ import (
"github.com/spf13/cobra"
)
var exportAutoCmd = &cobra.Command{
Use: "auto",
Short: "Export automation objects",
Long: "The export auto sub-commands export automation object in YAML format.",
var resumeImageCmd = &cobra.Command{
Use: "image",
Short: "Resume image automation objects",
Long: "The resume image sub-commands resume suspended image automation objects.",
}
func init() {
exportCmd.AddCommand(exportAutoCmd)
resumeCmd.AddCommand(resumeImageCmd)
}

@ -23,11 +23,11 @@ import (
)
var resumeImageRepositoryCmd = &cobra.Command{
Use: "image-repository [name]",
Use: "repository [name]",
Short: "Resume a suspended ImageRepository",
Long: `The resume command marks a previously suspended ImageRepository resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing ImageRepository
flux resume auto image-repository alpine
flux resume image repository alpine
`,
RunE: resumeCommand{
names: imageRepositoryNames,
@ -36,7 +36,7 @@ var resumeImageRepositoryCmd = &cobra.Command{
}
func init() {
resumeAutoCmd.AddCommand(resumeImageRepositoryCmd)
resumeImageCmd.AddCommand(resumeImageRepositoryCmd)
}
func (obj imageRepositoryAdapter) getObservedGeneration() int64 {

@ -23,11 +23,11 @@ import (
)
var resumeImageUpdateCmd = &cobra.Command{
Use: "image-update [name]",
Use: "update [name]",
Short: "Resume a suspended ImageUpdateAutomation",
Long: `The resume command marks a previously suspended ImageUpdateAutomation resource for reconciliation and waits for it to finish.`,
Example: ` # Resume reconciliation for an existing ImageUpdateAutomation
flux resume auto image-update latest-images
flux resume image update latest-images
`,
RunE: resumeCommand{
names: imageUpdateAutomationNames,
@ -36,7 +36,7 @@ var resumeImageUpdateCmd = &cobra.Command{
}
func init() {
resumeAutoCmd.AddCommand(resumeImageUpdateCmd)
resumeImageCmd.AddCommand(resumeImageUpdateCmd)
}
func (obj imageUpdateAutomationAdapter) setUnsuspended() {

@ -1,31 +0,0 @@
/*
Copyright 2020 The Flux authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"github.com/spf13/cobra"
)
var suspendAutoCmd = &cobra.Command{
Use: "auto",
Short: "Suspend automation objects",
Long: "The suspend auto sub-commands suspend the reconciliation of an automation object.",
}
func init() {
suspendCmd.AddCommand(suspendAutoCmd)
}

@ -0,0 +1,31 @@
/*
Copyright 2020 The Flux authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"github.com/spf13/cobra"
)
var suspendImageCmd = &cobra.Command{
Use: "image",
Short: "Suspend image automation objects",
Long: "The suspend image sub-commands suspend the reconciliation of an image automation object.",
}
func init() {
suspendCmd.AddCommand(suspendImageCmd)
}

@ -23,11 +23,11 @@ import (
)
var suspendImageRepositoryCmd = &cobra.Command{
Use: "image-repository [name]",
Use: "repository [name]",
Short: "Suspend reconciliation of an ImageRepository",
Long: "The suspend command disables the reconciliation of a ImageRepository resource.",
Long: "The suspend image repository command disables the reconciliation of a ImageRepository resource.",
Example: ` # Suspend reconciliation for an existing ImageRepository
flux suspend auto image-repository alpine
flux suspend image repository alpine
`,
RunE: suspendCommand{
names: imageRepositoryNames,
@ -36,7 +36,7 @@ var suspendImageRepositoryCmd = &cobra.Command{
}
func init() {
suspendAutoCmd.AddCommand(suspendImageRepositoryCmd)
suspendImageCmd.AddCommand(suspendImageRepositoryCmd)
}
func (obj imageRepositoryAdapter) isSuspended() bool {

@ -23,11 +23,11 @@ import (
)
var suspendImageUpdateCmd = &cobra.Command{
Use: "image-update [name]",
Use: "update [name]",
Short: "Suspend reconciliation of an ImageUpdateAutomation",
Long: "The suspend command disables the reconciliation of a ImageUpdateAutomation resource.",
Long: "The suspend image update command disables the reconciliation of a ImageUpdateAutomation resource.",
Example: ` # Suspend reconciliation for an existing ImageUpdateAutomation
flux suspend auto image-update latest-images
flux suspend image update latest-images
`,
RunE: suspendCommand{
names: imageUpdateAutomationNames,
@ -36,7 +36,7 @@ var suspendImageUpdateCmd = &cobra.Command{
}
func init() {
suspendAutoCmd.AddCommand(suspendImageUpdateCmd)
suspendImageCmd.AddCommand(suspendImageUpdateCmd)
}
func (update imageUpdateAutomationAdapter) isSuspended() bool {

@ -30,8 +30,8 @@ The create sub-commands generate sources and resources.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux create alert](flux_create_alert.md) - Create or update a Alert resource
* [flux create alert-provider](flux_create_alert-provider.md) - Create or update a Provider resource
* [flux create auto](flux_create_auto.md) - Create or update resources dealing with automation
* [flux create helmrelease](flux_create_helmrelease.md) - Create or update a HelmRelease resource
* [flux create image](flux_create_image.md) - Create or update resources dealing with image automation
* [flux create kustomization](flux_create_kustomization.md) - Create or update a Kustomization resource
* [flux create receiver](flux_create_receiver.md) - Create or update a Receiver resource
* [flux create secret](flux_create_secret.md) - Create or update Kubernetes secrets

@ -1,17 +1,17 @@
## flux create auto
## flux create image
Create or update resources dealing with automation
Create or update resources dealing with image automation
### Synopsis
The create auto sub-cmmands works with automation objects; that is,
The create image sub-commands work with image automation objects; that is,
object controlling updates to git based on e.g., new container images
being available.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -30,7 +30,7 @@ being available.
### SEE ALSO
* [flux create](flux_create.md) - Create or update sources and resources
* [flux create auto image-policy](flux_create_auto_image-policy.md) - Create or update an ImagePolicy object
* [flux create auto image-repository](flux_create_auto_image-repository.md) - Create or update an ImageRepository object
* [flux create auto image-update](flux_create_auto_image-update.md) - Create or update an ImageUpdateAutomation object
* [flux create image policy](flux_create_image_policy.md) - Create or update an ImagePolicy object
* [flux create image repository](flux_create_image_repository.md) - Create or update an ImageRepository object
* [flux create image update](flux_create_image_update.md) - Create or update an ImageUpdateAutomation object

@ -1,10 +1,10 @@
## flux create auto image-policy
## flux create image policy
Create or update an ImagePolicy object
### Synopsis
The create auto image-policy command generates an ImagePolicy resource.
The create image policy command generates an ImagePolicy resource.
An ImagePolicy object calculates a "latest image" given an image
repository and a policy, e.g., semver.
@ -12,13 +12,13 @@ The image that sorts highest according to the policy is recorded in
the status of the object.
```
flux create auto image-policy <name> [flags]
flux create image policy <name> [flags]
```
### Options
```
-h, --help help for image-policy
-h, --help help for policy
--image-ref string the name of an image repository object
--semver string a semver range to apply to tags; e.g., '1.x'
```
@ -38,5 +38,5 @@ flux create auto image-policy <name> [flags]
### SEE ALSO
* [flux create auto](flux_create_auto.md) - Create or update resources dealing with automation
* [flux create image](flux_create_image.md) - Create or update resources dealing with image automation

@ -1,20 +1,20 @@
## flux create auto image-repository
## flux create image repository
Create or update an ImageRepository object
### Synopsis
The create auto image-repository command generates an ImageRepository resource.
The create image repository command generates an ImageRepository resource.
An ImageRepository object specifies an image repository to scan.
```
flux create auto image-repository <name> [flags]
flux create image repository <name> [flags]
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
--image string the image repository to scan; e.g., library/alpine
--scan-timeout duration a timeout for scanning; this defaults to the interval if not set
--secret-ref string the name of a docker-registry secret to use for credentials
@ -35,5 +35,5 @@ flux create auto image-repository <name> [flags]
### SEE ALSO
* [flux create auto](flux_create_auto.md) - Create or update resources dealing with automation
* [flux create image](flux_create_image.md) - Create or update resources dealing with image automation

@ -1,15 +1,15 @@
## flux create auto image-update
## flux create image update
Create or update an ImageUpdateAutomation object
### Synopsis
The create auto image-update command generates an ImageUpdateAutomation resource.
The create image update command generates an ImageUpdateAutomation resource.
An ImageUpdateAutomation object specifies an automated update to images
mentioned in YAMLs in a git repository.
```
flux create auto image-update <name> [flags]
flux create image update <name> [flags]
```
### Options
@ -20,7 +20,7 @@ flux create auto image-update <name> [flags]
--branch string the branch to push commits to
--commit-template string a template for commit messages
--git-repo-ref string the name of a GitRepository resource with details of the upstream git repository
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -38,5 +38,5 @@ flux create auto image-update <name> [flags]
### SEE ALSO
* [flux create auto](flux_create_auto.md) - Create or update resources dealing with automation
* [flux create image](flux_create_image.md) - Create or update resources dealing with image automation

@ -28,8 +28,8 @@ The export sub-commands export resources in YAML format.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux export alert](flux_export_alert.md) - Export Alert resources in YAML format
* [flux export alert-provider](flux_export_alert-provider.md) - Export Provider resources in YAML format
* [flux export auto](flux_export_auto.md) - Export automation objects
* [flux export helmrelease](flux_export_helmrelease.md) - Export HelmRelease resources in YAML format
* [flux export image](flux_export_image.md) - Export image automation objects
* [flux export kustomization](flux_export_kustomization.md) - Export Kustomization resources in YAML format
* [flux export receiver](flux_export_receiver.md) - Export Receiver resources in YAML format
* [flux export source](flux_export_source.md) - Export sources

@ -1,15 +1,15 @@
## flux export auto
## flux export image
Export automation objects
Export image automation objects
### Synopsis
The export auto sub-commands export automation object in YAML format.
The export image sub-commands export image automation objects in YAML format.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -26,7 +26,7 @@ The export auto sub-commands export automation object in YAML format.
### SEE ALSO
* [flux export](flux_export.md) - Export resources in YAML format
* [flux export auto image-policy](flux_export_auto_image-policy.md) - Export ImagePolicy resources in YAML format
* [flux export auto image-repository](flux_export_auto_image-repository.md) - Export ImageRepository resources in YAML format
* [flux export auto image-update](flux_export_auto_image-update.md) - Export ImageUpdateAutomation resources in YAML format
* [flux export image policy](flux_export_image_policy.md) - Export ImagePolicy resources in YAML format
* [flux export image repository](flux_export_image_repository.md) - Export ImageRepository resources in YAML format
* [flux export image update](flux_export_image_update.md) - Export ImageUpdateAutomation resources in YAML format

@ -1,30 +1,30 @@
## flux export auto image-policy
## flux export image policy
Export ImagePolicy resources in YAML format
### Synopsis
The export image-policy command exports one or all ImagePolicy resources in YAML format.
The export image policy command exports one or all ImagePolicy resources in YAML format.
```
flux export auto image-policy [name] [flags]
flux export image policy [name] [flags]
```
### Examples
```
# Export all ImagePolicy resources
flux export auto image-policy --all > image-policies.yaml
flux export image policy --all > image-policies.yaml
# Export a specific policy
flux export auto image-policy alpine1x > alpine1x.yaml
flux export image policy alpine1x > alpine1x.yaml
```
### Options
```
-h, --help help for image-policy
-h, --help help for policy
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux export auto image-policy [name] [flags]
### SEE ALSO
* [flux export auto](flux_export_auto.md) - Export automation objects
* [flux export image](flux_export_image.md) - Export image automation objects

@ -1,30 +1,30 @@
## flux export auto image-repository
## flux export image repository
Export ImageRepository resources in YAML format
### Synopsis
The export image-repository command exports one or all ImageRepository resources in YAML format.
The export image repository command exports one or all ImageRepository resources in YAML format.
```
flux export auto image-repository [name] [flags]
flux export image repository [name] [flags]
```
### Examples
```
# Export all ImageRepository resources
flux export auto image-repository --all > image-repositories.yaml
flux export image repository --all > image-repositories.yaml
# Export a Provider
flux export auto image-repository alpine > alpine.yaml
# Export a specific ImageRepository resource
flux export image repository alpine > alpine.yaml
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux export auto image-repository [name] [flags]
### SEE ALSO
* [flux export auto](flux_export_auto.md) - Export automation objects
* [flux export image](flux_export_image.md) - Export image automation objects

@ -1,30 +1,30 @@
## flux export auto image-update
## flux export image update
Export ImageUpdateAutomation resources in YAML format
### Synopsis
The export image-update command exports one or all ImageUpdateAutomation resources in YAML format.
The export image update command exports one or all ImageUpdateAutomation resources in YAML format.
```
flux export auto image-update [name] [flags]
flux export image update [name] [flags]
```
### Examples
```
# Export all ImageUpdateAutomation resources
flux export auto image-update --all > updates.yaml
flux export image update --all > updates.yaml
# Export a specific automation
flux export auto image-update latest-images > latest.yaml
flux export image update latest-images > latest.yaml
```
### Options
```
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux export auto image-update [name] [flags]
### SEE ALSO
* [flux export auto](flux_export_auto.md) - Export automation objects
* [flux export image](flux_export_image.md) - Export image automation objects

@ -28,8 +28,8 @@ The get sub-commands print the statuses of sources and resources.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux get alert-providers](flux_get_alert-providers.md) - Get Provider statuses
* [flux get alerts](flux_get_alerts.md) - Get Alert statuses
* [flux get auto](flux_get_auto.md) - Get automation statuses
* [flux get helmreleases](flux_get_helmreleases.md) - Get HelmRelease statuses
* [flux get image](flux_get_image.md) - Get image automation object status
* [flux get kustomizations](flux_get_kustomizations.md) - Get Kustomization statuses
* [flux get receivers](flux_get_receivers.md) - Get Receiver statuses
* [flux get sources](flux_get_sources.md) - Get source statuses

@ -1,15 +1,15 @@
## flux get auto
## flux get image
Get automation statuses
Get image automation object status
### Synopsis
The get auto sub-commands print the statuses of the automation objects.
The get image sub-commands print the status of image automation objects.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -26,7 +26,7 @@ The get auto sub-commands print the statuses of the automation objects.
### SEE ALSO
* [flux get](flux_get.md) - Get sources and resources
* [flux get auto image-policy](flux_get_auto_image-policy.md) - Get ImagePolicy statuses
* [flux get auto image-repository](flux_get_auto_image-repository.md) - Get ImageRepository statuses
* [flux get auto image-update](flux_get_auto_image-update.md) - Get ImageUpdateAutomation statuses
* [flux get image policy](flux_get_image_policy.md) - Get ImagePolicy status
* [flux get image repository](flux_get_image_repository.md) - Get ImageRepository status
* [flux get image update](flux_get_image_update.md) - Get ImageUpdateAutomation status

@ -1,30 +1,30 @@
## flux get auto image-policy
## flux get image policy
Get ImagePolicy statuses
Get ImagePolicy status
### Synopsis
The get auto image-policy command prints the status of ImagePolicy objects.
The get image policy command prints the status of ImagePolicy objects.
```
flux get auto image-policy [flags]
flux get image policy [flags]
```
### Examples
```
# List all image policies and their status
flux get auto image-policy
flux get image policy
# List image policies from all namespaces
flux get auto image-policy --all-namespaces
flux get image policy --all-namespaces
```
### Options
```
-h, --help help for image-policy
-h, --help help for policy
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux get auto image-policy [flags]
### SEE ALSO
* [flux get auto](flux_get_auto.md) - Get automation statuses
* [flux get image](flux_get_image.md) - Get image automation object status

@ -1,30 +1,30 @@
## flux get auto image-repository
## flux get image repository
Get ImageRepository statuses
Get ImageRepository status
### Synopsis
The get auto image-repository command prints the status of ImageRepository objects.
The get image repository command prints the status of ImageRepository objects.
```
flux get auto image-repository [flags]
flux get image repository [flags]
```
### Examples
```
# List all image repositories and their status
flux get auto image-repository
flux get image repository
# List image repositories from all namespaces
flux get auto image-repository --all-namespaces
flux get image repository --all-namespaces
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux get auto image-repository [flags]
### SEE ALSO
* [flux get auto](flux_get_auto.md) - Get automation statuses
* [flux get image](flux_get_image.md) - Get image automation object status

@ -1,30 +1,30 @@
## flux get auto image-update
## flux get image update
Get ImageUpdateAutomation statuses
Get ImageUpdateAutomation status
### Synopsis
The get auto image-update command prints the status of ImageUpdateAutomation objects.
The get image update command prints the status of ImageUpdateAutomation objects.
```
flux get auto image-update [flags]
flux get image update [flags]
```
### Examples
```
# List all image update automation object and their status
flux get auto image-update
flux get image update
# List image update automations from all namespaces
flux get auto image-update --all-namespaces
flux get image update --all-namespaces
```
### Options
```
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -40,5 +40,5 @@ flux get auto image-update [flags]
### SEE ALSO
* [flux get auto](flux_get_auto.md) - Get automation statuses
* [flux get image](flux_get_image.md) - Get image automation object status

@ -27,8 +27,8 @@ The reconcile sub-commands trigger a reconciliation of sources and resources.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux reconcile alert](flux_reconcile_alert.md) - Reconcile an Alert
* [flux reconcile alert-provider](flux_reconcile_alert-provider.md) - Reconcile a Provider
* [flux reconcile auto](flux_reconcile_auto.md) - Reconcile automation objects
* [flux reconcile helmrelease](flux_reconcile_helmrelease.md) - Reconcile a HelmRelease resource
* [flux reconcile image](flux_reconcile_image.md) - Reconcile image automation objects
* [flux reconcile kustomization](flux_reconcile_kustomization.md) - Reconcile a Kustomization resource
* [flux reconcile receiver](flux_reconcile_receiver.md) - Reconcile a Receiver
* [flux reconcile source](flux_reconcile_source.md) - Reconcile sources

@ -1,15 +1,15 @@
## flux reconcile auto
## flux reconcile image
Reconcile automation objects
Reconcile image automation objects
### Synopsis
The reconcile auto sub-commands trigger a reconciliation of automation objects.
The reconcile sub-commands trigger a reconciliation of image automation objects.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -25,6 +25,6 @@ The reconcile auto sub-commands trigger a reconciliation of automation objects.
### SEE ALSO
* [flux reconcile](flux_reconcile.md) - Reconcile sources and resources
* [flux reconcile auto image-repository](flux_reconcile_auto_image-repository.md) - Reconcile an ImageRepository
* [flux reconcile auto image-update](flux_reconcile_auto_image-update.md) - Reconcile an ImageUpdateAutomation
* [flux reconcile image repository](flux_reconcile_image_repository.md) - Reconcile an ImageRepository
* [flux reconcile image update](flux_reconcile_image_update.md) - Reconcile an ImageUpdateAutomation

@ -1,27 +1,27 @@
## flux reconcile auto image-repository
## flux reconcile image repository
Reconcile an ImageRepository
### Synopsis
The reconcile auto image-repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.
The reconcile image repository command triggers a reconciliation of an ImageRepository resource and waits for it to finish.
```
flux reconcile auto image-repository [name] [flags]
flux reconcile image repository [name] [flags]
```
### Examples
```
# Trigger an scan for an existing image repository
flux reconcile auto image-repository alpine
flux reconcile image repository alpine
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux reconcile auto image-repository [name] [flags]
### SEE ALSO
* [flux reconcile auto](flux_reconcile_auto.md) - Reconcile automation objects
* [flux reconcile image](flux_reconcile_image.md) - Reconcile image automation objects

@ -1,27 +1,27 @@
## flux reconcile auto image-update
## flux reconcile image update
Reconcile an ImageUpdateAutomation
### Synopsis
The reconcile auto image-update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.
The reconcile image update command triggers a reconciliation of an ImageUpdateAutomation resource and waits for it to finish.
```
flux reconcile auto image-update [name] [flags]
flux reconcile image update [name] [flags]
```
### Examples
```
# Trigger an automation run for an existing image update automation
flux reconcile auto image-update latest-images
flux reconcile image update latest-images
```
### Options
```
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux reconcile auto image-update [name] [flags]
### SEE ALSO
* [flux reconcile auto](flux_reconcile_auto.md) - Reconcile automation objects
* [flux reconcile image](flux_reconcile_image.md) - Reconcile image automation objects

@ -26,8 +26,8 @@ The resume sub-commands resume a suspended resource.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux resume alert](flux_resume_alert.md) - Resume a suspended Alert
* [flux resume auto](flux_resume_auto.md) - Resume automation objects
* [flux resume helmrelease](flux_resume_helmrelease.md) - Resume a suspended HelmRelease
* [flux resume image](flux_resume_image.md) - Resume image automation objects
* [flux resume kustomization](flux_resume_kustomization.md) - Resume a suspended Kustomization
* [flux resume receiver](flux_resume_receiver.md) - Resume a suspended Receiver
* [flux resume source](flux_resume_source.md) - Resume sources

@ -1,15 +1,15 @@
## flux resume auto
## flux resume image
Resume automation objects
Resume image automation objects
### Synopsis
The resume auto sub-commands resume a suspended automation object.
The resume image sub-commands resume suspended image automation objects.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -25,6 +25,6 @@ The resume auto sub-commands resume a suspended automation object.
### SEE ALSO
* [flux resume](flux_resume.md) - Resume suspended resources
* [flux resume auto image-repository](flux_resume_auto_image-repository.md) - Resume a suspended ImageRepository
* [flux resume auto image-update](flux_resume_auto_image-update.md) - Resume a suspended ImageUpdateAutomation
* [flux resume image repository](flux_resume_image_repository.md) - Resume a suspended ImageRepository
* [flux resume image update](flux_resume_image_update.md) - Resume a suspended ImageUpdateAutomation

@ -1,4 +1,4 @@
## flux resume auto image-repository
## flux resume image repository
Resume a suspended ImageRepository
@ -7,21 +7,21 @@ Resume a suspended ImageRepository
The resume command marks a previously suspended ImageRepository resource for reconciliation and waits for it to finish.
```
flux resume auto image-repository [name] [flags]
flux resume image repository [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing ImageRepository
flux resume auto image-repository alpine
flux resume image repository alpine
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux resume auto image-repository [name] [flags]
### SEE ALSO
* [flux resume auto](flux_resume_auto.md) - Resume automation objects
* [flux resume image](flux_resume_image.md) - Resume image automation objects

@ -1,4 +1,4 @@
## flux resume auto image-update
## flux resume image update
Resume a suspended ImageUpdateAutomation
@ -7,21 +7,21 @@ Resume a suspended ImageUpdateAutomation
The resume command marks a previously suspended ImageUpdateAutomation resource for reconciliation and waits for it to finish.
```
flux resume auto image-update [name] [flags]
flux resume image update [name] [flags]
```
### Examples
```
# Resume reconciliation for an existing ImageUpdateAutomation
flux resume auto image-update latest-images
flux resume image update latest-images
```
### Options
```
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux resume auto image-update [name] [flags]
### SEE ALSO
* [flux resume auto](flux_resume_auto.md) - Resume automation objects
* [flux resume image](flux_resume_image.md) - Resume image automation objects

@ -26,8 +26,8 @@ The suspend sub-commands suspend the reconciliation of a resource.
* [flux](flux.md) - Command line utility for assembling Kubernetes CD pipelines
* [flux suspend alert](flux_suspend_alert.md) - Suspend reconciliation of Alert
* [flux suspend auto](flux_suspend_auto.md) - Suspend automation objects
* [flux suspend helmrelease](flux_suspend_helmrelease.md) - Suspend reconciliation of HelmRelease
* [flux suspend image](flux_suspend_image.md) - Suspend image automation objects
* [flux suspend kustomization](flux_suspend_kustomization.md) - Suspend reconciliation of Kustomization
* [flux suspend receiver](flux_suspend_receiver.md) - Suspend reconciliation of Receiver
* [flux suspend source](flux_suspend_source.md) - Suspend sources

@ -1,15 +1,15 @@
## flux suspend auto
## flux suspend image
Suspend automation objects
Suspend image automation objects
### Synopsis
The suspend auto sub-commands suspend the reconciliation of an automation object.
The suspend image sub-commands suspend the reconciliation of an image automation object.
### Options
```
-h, --help help for auto
-h, --help help for image
```
### Options inherited from parent commands
@ -25,6 +25,6 @@ The suspend auto sub-commands suspend the reconciliation of an automation object
### SEE ALSO
* [flux suspend](flux_suspend.md) - Suspend resources
* [flux suspend auto image-repository](flux_suspend_auto_image-repository.md) - Suspend reconciliation of an ImageRepository
* [flux suspend auto image-update](flux_suspend_auto_image-update.md) - Suspend reconciliation of an ImageUpdateAutomation
* [flux suspend image repository](flux_suspend_image_repository.md) - Suspend reconciliation of an ImageRepository
* [flux suspend image update](flux_suspend_image_update.md) - Suspend reconciliation of an ImageUpdateAutomation

@ -1,27 +1,27 @@
## flux suspend auto image-repository
## flux suspend image repository
Suspend reconciliation of an ImageRepository
### Synopsis
The suspend command disables the reconciliation of a ImageRepository resource.
The suspend image repository command disables the reconciliation of a ImageRepository resource.
```
flux suspend auto image-repository [name] [flags]
flux suspend image repository [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing ImageRepository
flux suspend auto image-repository alpine
flux suspend image repository alpine
```
### Options
```
-h, --help help for image-repository
-h, --help help for repository
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux suspend auto image-repository [name] [flags]
### SEE ALSO
* [flux suspend auto](flux_suspend_auto.md) - Suspend automation objects
* [flux suspend image](flux_suspend_image.md) - Suspend image automation objects

@ -1,27 +1,27 @@
## flux suspend auto image-update
## flux suspend image update
Suspend reconciliation of an ImageUpdateAutomation
### Synopsis
The suspend command disables the reconciliation of a ImageUpdateAutomation resource.
The suspend image update command disables the reconciliation of a ImageUpdateAutomation resource.
```
flux suspend auto image-update [name] [flags]
flux suspend image update [name] [flags]
```
### Examples
```
# Suspend reconciliation for an existing ImageUpdateAutomation
flux suspend auto image-update latest-images
flux suspend image update latest-images
```
### Options
```
-h, --help help for image-update
-h, --help help for update
```
### Options inherited from parent commands
@ -36,5 +36,5 @@ flux suspend auto image-update [name] [flags]
### SEE ALSO
* [flux suspend auto](flux_suspend_auto.md) - Suspend automation objects
* [flux suspend image](flux_suspend_image.md) - Suspend image automation objects
Loading…
Cancel
Save