From 8e3a09cf7fc23200ae602bcc9ada8a7112fdc063 Mon Sep 17 00:00:00 2001 From: Murugappan Chetty Date: Tue, 9 Nov 2021 01:51:43 -0800 Subject: [PATCH] update status of commands (#1508) * update status of commands * update status of commands * update status of commands * update status of commands * update status of commands * update status of commands * update status of commands --- docs/cmd/kn_container_add.md | 6 +++--- docs/cmd/kn_domain_update.md | 2 +- docs/cmd/kn_service_create.md | 2 +- docs/cmd/kn_service_delete.md | 2 +- docs/cmd/kn_service_describe.md | 2 +- docs/cmd/kn_service_export.md | 12 ++++++------ docs/cmd/kn_service_import.md | 4 ++-- docs/cmd/kn_service_list.md | 2 +- docs/cmd/kn_service_update.md | 2 +- pkg/kn/commands/container/add.go | 6 +++--- pkg/kn/commands/domain/update.go | 2 +- pkg/kn/commands/service/create.go | 2 +- pkg/kn/commands/service/delete.go | 2 +- pkg/kn/commands/service/describe.go | 2 +- pkg/kn/commands/service/export.go | 12 ++++++------ pkg/kn/commands/service/import.go | 4 ++-- pkg/kn/commands/service/list.go | 2 +- pkg/kn/commands/service/update.go | 2 +- 18 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/cmd/kn_container_add.md b/docs/cmd/kn_container_add.md index 9dcc71be9..0ba471626 100644 --- a/docs/cmd/kn_container_add.md +++ b/docs/cmd/kn_container_add.md @@ -10,16 +10,16 @@ kn container add NAME ``` - The command is experimental and may change in the future releases. + The command is Beta and may change in the future releases. The 'container add' represents utility command that prints YAML container spec to standard output. It's useful for multi-container use cases to create definition with help of standard 'kn' option flags. It accepts all container related flag available for 'service create'. The command can be chained through Unix pipes to create multiple containers at once. - # Add a container 'sidecar' from image 'docker.io/example/sidecar' and print it to standard output + # Add a container 'sidecar' from image 'docker.io/example/sidecar' and print it to standard output (Beta) kn container add sidecar --image docker.io/example/sidecar - # Add command can be chained by standard Unix pipe symbol '|' and passed to 'service add|update|apply' commands + # Add command can be chained by standard Unix pipe symbol '|' and passed to 'service add|update|apply' commands (Beta) kn container add sidecar --image docker.io/example/sidecar:first | \ kn container add second --image docker.io/example/sidecar:second | \ kn service create myksvc --image docker.io/example/my-app:latest --containers - diff --git a/docs/cmd/kn_domain_update.md b/docs/cmd/kn_domain_update.md index 7611277b0..52dd3f4a4 100644 --- a/docs/cmd/kn_domain_update.md +++ b/docs/cmd/kn_domain_update.md @@ -11,7 +11,7 @@ kn domain update NAME ``` # Update a domain mappings 'hello.example.com' for Knative service 'hello' - kn domain create hello.example.com --refFlags hello + kn domain update hello.example.com --refFlags hello ``` ### Options diff --git a/docs/cmd/kn_service_create.md b/docs/cmd/kn_service_create.md index af2e7cbb9..f2cfdf594 100644 --- a/docs/cmd/kn_service_create.md +++ b/docs/cmd/kn_service_create.md @@ -45,7 +45,7 @@ kn service create NAME --image IMAGE # [https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/] kn service create s4gpu --image knativesamples/hellocuda-go --request memory=250Mi,cpu=200m --limit nvidia.com/gpu=1 - # Create the service in offline mode instead of kubernetes cluster + # Create the service in offline mode instead of kubernetes cluster (Beta) kn service create gitopstest -n test-ns --image knativesamples/helloworld --target=/user/knfiles kn service create gitopstest --image knativesamples/helloworld --target=/user/knfiles/test.yaml kn service create gitopstest --image knativesamples/helloworld --target=/user/knfiles/test.json diff --git a/docs/cmd/kn_service_delete.md b/docs/cmd/kn_service_delete.md index 3c7cdc46a..8d64809be 100644 --- a/docs/cmd/kn_service_delete.md +++ b/docs/cmd/kn_service_delete.md @@ -19,7 +19,7 @@ kn service delete NAME [NAME ...] # Delete all services in 'ns1' namespace kn service delete --all -n ns1 - # Delete the services in offline mode instead of kubernetes cluster + # Delete the services in offline mode instead of kubernetes cluster (Beta) kn service delete test -n test-ns --target=/user/knfiles kn service delete test --target=/user/knfiles/test.yaml kn service delete test --target=/user/knfiles/test.json diff --git a/docs/cmd/kn_service_describe.md b/docs/cmd/kn_service_describe.md index 43677e599..d0c7b2317 100644 --- a/docs/cmd/kn_service_describe.md +++ b/docs/cmd/kn_service_describe.md @@ -19,7 +19,7 @@ kn service describe NAME # Print only service URL kn service describe svc -o url - # Describe the services in offline mode instead of kubernetes cluster + # Describe the services in offline mode instead of kubernetes cluster (Beta) kn service describe test -n test-ns --target=/user/knfiles kn service describe test --target=/user/knfiles/test.yaml kn service describe test --target=/user/knfiles/test.json diff --git a/docs/cmd/kn_service_export.md b/docs/cmd/kn_service_export.md index 9b328e7e6..85cf4742e 100644 --- a/docs/cmd/kn_service_export.md +++ b/docs/cmd/kn_service_export.md @@ -10,16 +10,16 @@ kn service export NAME ``` - # Export a service in YAML format + # Export a service in YAML format (Beta) kn service export foo -n bar -o yaml - # Export a service in JSON format + # Export a service in JSON format (Beta) kn service export foo -n bar -o json - # Export a service with revisions + # Export a service with revisions (Beta) kn service export foo --with-revisions --mode=export -n bar -o json - # Export services in kubectl friendly format, as a list kind, one service item for each revision + # Export services in kubectl friendly format, as a list kind, one service item for each revision (Beta) kn service export foo --with-revisions --mode=replay -n bar -o json ``` @@ -28,12 +28,12 @@ kn service export NAME ``` --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) -h, --help help for export - --mode string Format for exporting all routed revisions. One of replay|export (experimental) + --mode string Format for exporting all routed revisions. One of replay|export (Beta) -n, --namespace string Specify the namespace to operate in. -o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file. --show-managed-fields If true, keep the managedFields when printing objects in JSON or YAML format. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --with-revisions Export all routed revisions (experimental) + --with-revisions Export all routed revisions (Beta) ``` ### Options inherited from parent commands diff --git a/docs/cmd/kn_service_import.md b/docs/cmd/kn_service_import.md index 2ea72d75b..603cdf538 100644 --- a/docs/cmd/kn_service_import.md +++ b/docs/cmd/kn_service_import.md @@ -10,10 +10,10 @@ kn service import FILENAME ``` - # Import a service from YAML file + # Import a service from YAML file (Beta) kn service import /path/to/file.yaml - # Import a service from JSON file + # Import a service from JSON file (Beta) kn service import /path/to/file.json ``` diff --git a/docs/cmd/kn_service_list.md b/docs/cmd/kn_service_list.md index fb0dc444b..b8c1acf93 100644 --- a/docs/cmd/kn_service_list.md +++ b/docs/cmd/kn_service_list.md @@ -19,7 +19,7 @@ kn service list # List service 'web' kn service list web - # List the services in offline mode instead of kubernetes cluster + # List the services in offline mode instead of kubernetes cluster (Beta) kn service list --target=/user/knfiles kn service list --target=/user/knfiles/test.json kn service list --target=/user/knfiles/test.yaml diff --git a/docs/cmd/kn_service_update.md b/docs/cmd/kn_service_update.md index 5e0c6787f..2736bfff7 100644 --- a/docs/cmd/kn_service_update.md +++ b/docs/cmd/kn_service_update.md @@ -34,7 +34,7 @@ kn service update NAME # rest will automatically be directed to echo-v3 (the remaining revision) kn service update svc --traffic stable=50,staging=40 - # Update the service in offline mode instead of kubernetes cluster + # Update the service in offline mode instead of kubernetes cluster (Beta) kn service update gitopstest -n test-ns --env KEY1=VALUE1 --target=/user/knfiles kn service update gitopstest --env KEY1=VALUE1 --target=/user/knfiles/test.yaml kn service update gitopstest --env KEY1=VALUE1 --target=/user/knfiles/test.json diff --git a/pkg/kn/commands/container/add.go b/pkg/kn/commands/container/add.go index fb0b061be..c8788112f 100644 --- a/pkg/kn/commands/container/add.go +++ b/pkg/kn/commands/container/add.go @@ -33,16 +33,16 @@ func NewContainerAddCommand(p *commands.KnParams) *cobra.Command { Use: "add NAME", Short: "Add a container", Example: ` - The command is experimental and may change in the future releases. + The command is Beta and may change in the future releases. The 'container add' represents utility command that prints YAML container spec to standard output. It's useful for multi-container use cases to create definition with help of standard 'kn' option flags. It accepts all container related flag available for 'service create'. The command can be chained through Unix pipes to create multiple containers at once. - # Add a container 'sidecar' from image 'docker.io/example/sidecar' and print it to standard output + # Add a container 'sidecar' from image 'docker.io/example/sidecar' and print it to standard output (Beta) kn container add sidecar --image docker.io/example/sidecar - # Add command can be chained by standard Unix pipe symbol '|' and passed to 'service add|update|apply' commands + # Add command can be chained by standard Unix pipe symbol '|' and passed to 'service add|update|apply' commands (Beta) kn container add sidecar --image docker.io/example/sidecar:first | \ kn container add second --image docker.io/example/sidecar:second | \ kn service create myksvc --image docker.io/example/my-app:latest --containers -`, diff --git a/pkg/kn/commands/domain/update.go b/pkg/kn/commands/domain/update.go index e5da5ed3c..e56d0d875 100644 --- a/pkg/kn/commands/domain/update.go +++ b/pkg/kn/commands/domain/update.go @@ -35,7 +35,7 @@ func NewDomainMappingUpdateCommand(p *commands.KnParams) *cobra.Command { Short: "Update a domain mapping", Example: ` # Update a domain mappings 'hello.example.com' for Knative service 'hello' - kn domain create hello.example.com --refFlags hello`, + kn domain update hello.example.com --refFlags hello`, RunE: func(cmd *cobra.Command, args []string) (err error) { if len(args) != 1 { return errors.New("'kn domain create' requires the domain name given as single argument") diff --git a/pkg/kn/commands/service/create.go b/pkg/kn/commands/service/create.go index 2ab728e31..161b210bb 100644 --- a/pkg/kn/commands/service/create.go +++ b/pkg/kn/commands/service/create.go @@ -74,7 +74,7 @@ var create_example = ` # [https://kubernetes.io/docs/tasks/manage-gpus/scheduling-gpus/] kn service create s4gpu --image knativesamples/hellocuda-go --request memory=250Mi,cpu=200m --limit nvidia.com/gpu=1 - # Create the service in offline mode instead of kubernetes cluster + # Create the service in offline mode instead of kubernetes cluster (Beta) kn service create gitopstest -n test-ns --image knativesamples/helloworld --target=/user/knfiles kn service create gitopstest --image knativesamples/helloworld --target=/user/knfiles/test.yaml kn service create gitopstest --image knativesamples/helloworld --target=/user/knfiles/test.json` diff --git a/pkg/kn/commands/service/delete.go b/pkg/kn/commands/service/delete.go index 0307477f2..552bf2f1a 100644 --- a/pkg/kn/commands/service/delete.go +++ b/pkg/kn/commands/service/delete.go @@ -44,7 +44,7 @@ func NewServiceDeleteCommand(p *commands.KnParams) *cobra.Command { # Delete all services in 'ns1' namespace kn service delete --all -n ns1 - # Delete the services in offline mode instead of kubernetes cluster + # Delete the services in offline mode instead of kubernetes cluster (Beta) kn service delete test -n test-ns --target=/user/knfiles kn service delete test --target=/user/knfiles/test.yaml kn service delete test --target=/user/knfiles/test.json`, diff --git a/pkg/kn/commands/service/describe.go b/pkg/kn/commands/service/describe.go index 58df0e8b4..a38ecefdb 100644 --- a/pkg/kn/commands/service/describe.go +++ b/pkg/kn/commands/service/describe.go @@ -82,7 +82,7 @@ var describe_example = ` # Print only service URL kn service describe svc -o url - # Describe the services in offline mode instead of kubernetes cluster + # Describe the services in offline mode instead of kubernetes cluster (Beta) kn service describe test -n test-ns --target=/user/knfiles kn service describe test --target=/user/knfiles/test.yaml kn service describe test --target=/user/knfiles/test.json` diff --git a/pkg/kn/commands/service/export.go b/pkg/kn/commands/service/export.go index e55689922..570da9961 100644 --- a/pkg/kn/commands/service/export.go +++ b/pkg/kn/commands/service/export.go @@ -84,16 +84,16 @@ func NewServiceExportCommand(p *commands.KnParams) *cobra.Command { Use: "export NAME", Short: "Export a service and its revisions", Example: ` - # Export a service in YAML format + # Export a service in YAML format (Beta) kn service export foo -n bar -o yaml - # Export a service in JSON format + # Export a service in JSON format (Beta) kn service export foo -n bar -o json - # Export a service with revisions + # Export a service with revisions (Beta) kn service export foo --with-revisions --mode=export -n bar -o json - # Export services in kubectl friendly format, as a list kind, one service item for each revision + # Export services in kubectl friendly format, as a list kind, one service item for each revision (Beta) kn service export foo --with-revisions --mode=replay -n bar -o json`, RunE: func(cmd *cobra.Command, args []string) error { if len(args) != 1 { @@ -127,8 +127,8 @@ func NewServiceExportCommand(p *commands.KnParams) *cobra.Command { } flags := command.Flags() commands.AddNamespaceFlags(flags, false) - flags.Bool("with-revisions", false, "Export all routed revisions (experimental)") - flags.String("mode", "", "Format for exporting all routed revisions. One of replay|export (experimental)") + flags.Bool("with-revisions", false, "Export all routed revisions (Beta)") + flags.String("mode", "", "Format for exporting all routed revisions. One of replay|export (Beta)") machineReadablePrintFlags.AddFlags(command) return command } diff --git a/pkg/kn/commands/service/import.go b/pkg/kn/commands/service/import.go index 471e17521..64fac8790 100644 --- a/pkg/kn/commands/service/import.go +++ b/pkg/kn/commands/service/import.go @@ -43,10 +43,10 @@ func NewServiceImportCommand(p *commands.KnParams) *cobra.Command { Use: "import FILENAME", Short: "Import a service and its revisions (experimental)", Example: ` - # Import a service from YAML file + # Import a service from YAML file (Beta) kn service import /path/to/file.yaml - # Import a service from JSON file + # Import a service from JSON file (Beta) kn service import /path/to/file.json`, RunE: func(cmd *cobra.Command, args []string) error { if len(args) != 1 { diff --git a/pkg/kn/commands/service/list.go b/pkg/kn/commands/service/list.go index 30e3a58b8..1212a0db5 100644 --- a/pkg/kn/commands/service/list.go +++ b/pkg/kn/commands/service/list.go @@ -45,7 +45,7 @@ func NewServiceListCommand(p *commands.KnParams) *cobra.Command { # List service 'web' kn service list web - # List the services in offline mode instead of kubernetes cluster + # List the services in offline mode instead of kubernetes cluster (Beta) kn service list --target=/user/knfiles kn service list --target=/user/knfiles/test.json kn service list --target=/user/knfiles/test.yaml diff --git a/pkg/kn/commands/service/update.go b/pkg/kn/commands/service/update.go index 424e246b4..393fd8502 100644 --- a/pkg/kn/commands/service/update.go +++ b/pkg/kn/commands/service/update.go @@ -55,7 +55,7 @@ var updateExample = ` # rest will automatically be directed to echo-v3 (the remaining revision) kn service update svc --traffic stable=50,staging=40 - # Update the service in offline mode instead of kubernetes cluster + # Update the service in offline mode instead of kubernetes cluster (Beta) kn service update gitopstest -n test-ns --env KEY1=VALUE1 --target=/user/knfiles kn service update gitopstest --env KEY1=VALUE1 --target=/user/knfiles/test.yaml kn service update gitopstest --env KEY1=VALUE1 --target=/user/knfiles/test.json`