From 2889077a6459f0fb0fd86c59f8ed0a4b52372647 Mon Sep 17 00:00:00 2001 From: npamudika Date: Tue, 24 Mar 2020 16:40:07 +0530 Subject: [PATCH] Add login and logout commands to the README inside the tool and fix application list endpoint in sample config --- .../box/resources/sample/sample_config.yaml | 2 +- import-export-cli/docs/apictl_add_api.md | 14 ++-- .../docs/apictl_install_wso2am-operator.md | 38 ++++++++++ import-export-cli/docs/apictl_set.md | 2 +- import-export-cli/docs/apictl_uninstall.md | 1 + .../docs/apictl_uninstall_api-operator.md | 2 +- .../docs/apictl_uninstall_wso2am-operator.md | 37 ++++++++++ import-export-cli/docs/apictl_update_api.md | 2 + import-export-cli/resources/README.html | 22 ++++++ .../apictl_bash_completions.sh | 71 +++++++++++++++++++ .../apictl_zsh_completions.sh | 8 +-- 11 files changed, 186 insertions(+), 13 deletions(-) create mode 100644 import-export-cli/docs/apictl_install_wso2am-operator.md create mode 100644 import-export-cli/docs/apictl_uninstall_wso2am-operator.md diff --git a/import-export-cli/box/resources/sample/sample_config.yaml b/import-export-cli/box/resources/sample/sample_config.yaml index 4db8c962f..1e4fbdb33 100644 --- a/import-export-cli/box/resources/sample/sample_config.yaml +++ b/import-export-cli/box/resources/sample/sample_config.yaml @@ -8,7 +8,7 @@ environments: admin_endpoint: https://localhost:9443/api/am/admin/v0.16 api_list_endpoint: https://localhost:9443/api/am/publisher/v1/apis api_manager_endpoint: https://localhost:9443 - application_list_endpoint: https://localhost:9443/api/am/admin/v0.16/applications + application_list_endpoint: https://localhost:9443/api/am/store/v1/applications registration_endpoint: https://localhost:9443/client-registration/v0.16/register token_endpoint: https://localhost:8243/token sample-env2: diff --git a/import-export-cli/docs/apictl_add_api.md b/import-export-cli/docs/apictl_add_api.md index d23ebcd7e..b49bb5788 100644 --- a/import-export-cli/docs/apictl_add_api.md +++ b/import-export-cli/docs/apictl_add_api.md @@ -21,12 +21,14 @@ apictl add/update api -n petstore --from-file=./Swagger.json --replicas=3 --name ### Options ``` - -f, --from-file string Path to swagger file - -h, --help help for api - -n, --name string Name of the API - --namespace string namespace of API - --override Property to override the existing docker image with same name and version - --replicas int replica set (default 1) + -f, --from-file stringArray Path to swagger file + -h, --help help for api + -m, --mode string Property to override the deploying mode. Available modes: privateJet, sidecar + -n, --name string Name of the API + --namespace string namespace of API + --override Property to override the existing docker image with same name and version + --replicas int replica set (default 1) + -v, --version string Property to override the existing docker image with same name and version ``` ### Options inherited from parent commands diff --git a/import-export-cli/docs/apictl_install_wso2am-operator.md b/import-export-cli/docs/apictl_install_wso2am-operator.md new file mode 100644 index 000000000..59a632a5c --- /dev/null +++ b/import-export-cli/docs/apictl_install_wso2am-operator.md @@ -0,0 +1,38 @@ +## apictl install wso2am-operator + +Install WSO2AM Operator + +### Synopsis + +Install WSO2AM Operator in the configured K8s cluster + +``` +apictl install wso2am-operator [flags] +``` + +### Examples + +``` +apictl install wso2am-operator +apictl install wso2am-operator -f path/to/operator/configs +apictl install wso2am-operator -f path/to/operator/config/file.yaml +``` + +### Options + +``` + -f, --from-file string Path to wso2am-operator directory + -h, --help help for wso2am-operator +``` + +### Options inherited from parent commands + +``` + -k, --insecure Allow connections to SSL endpoints without certs + --verbose Enable verbose mode +``` + +### SEE ALSO + +* [apictl install](apictl_install.md) - Install an operator + diff --git a/import-export-cli/docs/apictl_set.md b/import-export-cli/docs/apictl_set.md index 2b92befb2..50361b3ef 100644 --- a/import-export-cli/docs/apictl_set.md +++ b/import-export-cli/docs/apictl_set.md @@ -28,7 +28,7 @@ apictl set --mode default ### Options ``` - --export-directory string Path to directory where APIs should be saved (default "/home/wasura/.wso2apictl/exported") + --export-directory string Path to directory where APIs should be saved (default "/home/naduni/.wso2apictl/exported") -h, --help help for set --http-request-timeout int Timeout for HTTP Client (default 10000) -m, --mode string mode of apictl diff --git a/import-export-cli/docs/apictl_uninstall.md b/import-export-cli/docs/apictl_uninstall.md index 1861a24cc..c77e8d523 100644 --- a/import-export-cli/docs/apictl_uninstall.md +++ b/import-export-cli/docs/apictl_uninstall.md @@ -29,4 +29,5 @@ apictl uninstall api-operator * [apictl](apictl.md) - CLI for Importing and Exporting APIs and Applications * [apictl uninstall api-operator](apictl_uninstall_api-operator.md) - Uninstall API Operator +* [apictl uninstall wso2am-operator](apictl_uninstall_wso2am-operator.md) - Uninstall WSO2AM Operator diff --git a/import-export-cli/docs/apictl_uninstall_api-operator.md b/import-export-cli/docs/apictl_uninstall_api-operator.md index 8cb3387bc..274398db5 100644 --- a/import-export-cli/docs/apictl_uninstall_api-operator.md +++ b/import-export-cli/docs/apictl_uninstall_api-operator.md @@ -14,7 +14,7 @@ apictl uninstall api-operator [flags] ``` apictl uninstall api-operator -apictl api-operator --force +apictl uninstall api-operator --force ``` ### Options diff --git a/import-export-cli/docs/apictl_uninstall_wso2am-operator.md b/import-export-cli/docs/apictl_uninstall_wso2am-operator.md new file mode 100644 index 000000000..cb9d93277 --- /dev/null +++ b/import-export-cli/docs/apictl_uninstall_wso2am-operator.md @@ -0,0 +1,37 @@ +## apictl uninstall wso2am-operator + +Uninstall WSO2AM Operator + +### Synopsis + +Uninstall WSO2AM Operator in the configured K8s cluster + +``` +apictl uninstall wso2am-operator [flags] +``` + +### Examples + +``` +apictl uninstall wso2am-operator +apictl uninstall wso2am-operator --force +``` + +### Options + +``` + --force Force uninstall WSO2AM Operator + -h, --help help for wso2am-operator +``` + +### Options inherited from parent commands + +``` + -k, --insecure Allow connections to SSL endpoints without certs + --verbose Enable verbose mode +``` + +### SEE ALSO + +* [apictl uninstall](apictl_uninstall.md) - Uninstall an operator + diff --git a/import-export-cli/docs/apictl_update_api.md b/import-export-cli/docs/apictl_update_api.md index 3ba91b4b0..7539f8296 100644 --- a/import-export-cli/docs/apictl_update_api.md +++ b/import-export-cli/docs/apictl_update_api.md @@ -23,9 +23,11 @@ apictl add/update api -n petstore --from-file=./Swagger.json --replicas=3 --name ``` -f, --from-file string Path to swagger file -h, --help help for api + -m, --mode string Property to override the deploying mode. Available modes: privateJet, sidecar -n, --name string Name of the API --namespace string namespace of API --replicas int replica set (default 1) + -v, --version string Property to override the existing docker image with same name and version ``` ### Options inherited from parent commands diff --git a/import-export-cli/resources/README.html b/import-export-cli/resources/README.html index 2163c043e..5d8753987 100644 --- a/import-export-cli/resources/README.html +++ b/import-export-cli/resources/README.html @@ -46,6 +46,28 @@

Global Flags

Display information and example usage of a command

Commands

+ +