From f36dd6cda11d491ab4b985f21e019c677cb20ed0 Mon Sep 17 00:00:00 2001 From: Felipe Publio Date: Fri, 26 Jul 2024 10:44:32 -0300 Subject: [PATCH] feat: Add help documentation in the gh wiki --- .github/workflows/wiki.yaml | 18 +++++ docs/auth/access_token/help.md | 23 +++++++ docs/auth/clients/create/help.md | 37 ++++++++++ docs/auth/clients/help.md | 25 +++++++ docs/auth/clients/list/help.md | 21 ++++++ docs/auth/clients/update/help.md | 38 ++++++++++ docs/auth/help.md | 28 ++++++++ docs/auth/login/help.md | 27 ++++++++ docs/auth/tenant/current/help.md | 21 ++++++ docs/auth/tenant/help.md | 27 ++++++++ docs/auth/tenant/list/help.md | 21 ++++++ docs/auth/tenant/set/help.md | 22 ++++++ docs/block-storage/help.md | 26 +++++++ docs/block-storage/snapshots/create/help.md | 27 ++++++++ docs/block-storage/snapshots/delete/help.md | 30 ++++++++ docs/block-storage/snapshots/get/help.md | 33 +++++++++ docs/block-storage/snapshots/help.md | 29 ++++++++ docs/block-storage/snapshots/list/help.md | 31 +++++++++ docs/block-storage/snapshots/rename/help.md | 28 ++++++++ docs/block-storage/snapshots/restore/help.md | 31 +++++++++ .../volume-attachment/create/help.md | 28 ++++++++ .../volume-attachment/delete/help.md | 26 +++++++ .../volume-attachment/get/help.md | 26 +++++++ docs/block-storage/volume-attachment/help.md | 25 +++++++ docs/block-storage/volume-types/help.md | 24 +++++++ docs/block-storage/volume-types/list/help.md | 22 ++++++ docs/block-storage/volumes/attach/help.md | 29 ++++++++ docs/block-storage/volumes/create/help.md | 26 +++++++ docs/block-storage/volumes/delete/help.md | 31 +++++++++ docs/block-storage/volumes/detach/help.md | 34 +++++++++ docs/block-storage/volumes/extend/help.md | 28 ++++++++ docs/block-storage/volumes/get/help.md | 33 +++++++++ docs/block-storage/volumes/help.md | 32 +++++++++ docs/block-storage/volumes/list/help.md | 30 ++++++++ docs/block-storage/volumes/rename/help.md | 28 ++++++++ docs/block-storage/volumes/retype/help.md | 28 ++++++++ docs/config/delete/help.md | 23 +++++++ docs/config/get-schema/help.md | 23 +++++++ docs/config/get/help.md | 24 +++++++ docs/config/help.md | 30 ++++++++ docs/config/list/help.md | 21 ++++++ docs/config/set/help.md | 24 +++++++ docs/container-registry/credentials/help.md | 24 +++++++ .../credentials/list/help.md | 25 +++++++ docs/container-registry/help.md | 27 ++++++++ docs/container-registry/images/delete/help.md | 28 ++++++++ docs/container-registry/images/get/help.md | 29 ++++++++ docs/container-registry/images/help.md | 26 +++++++ docs/container-registry/images/list/help.md | 31 +++++++++ .../registries/create/help.md | 28 ++++++++ .../registries/delete/help.md | 26 +++++++ .../container-registry/registries/get/help.md | 27 ++++++++ docs/container-registry/registries/help.md | 27 ++++++++ .../registries/list/help.md | 28 ++++++++ .../repositories/delete/help.md | 27 ++++++++ .../repositories/get/help.md | 28 ++++++++ docs/container-registry/repositories/help.md | 26 +++++++ .../repositories/list/help.md | 29 ++++++++ docs/dbaas/backups/delete/help.md | 26 +++++++ docs/dbaas/backups/get/help.md | 27 ++++++++ docs/dbaas/backups/help.md | 26 +++++++ docs/dbaas/backups/list/help.md | 30 ++++++++ docs/dbaas/datastores/get/help.md | 26 +++++++ docs/dbaas/datastores/help.md | 25 +++++++ docs/dbaas/datastores/list/help.md | 28 ++++++++ docs/dbaas/engines/get/help.md | 26 +++++++ docs/dbaas/engines/help.md | 25 +++++++ docs/dbaas/engines/list/help.md | 28 ++++++++ docs/dbaas/flavors/get/help.md | 26 +++++++ docs/dbaas/flavors/help.md | 25 +++++++ docs/dbaas/flavors/list/help.md | 29 ++++++++ docs/dbaas/help.md | 29 ++++++++ docs/dbaas/instances/backups/create/help.md | 29 ++++++++ docs/dbaas/instances/backups/delete/help.md | 27 ++++++++ docs/dbaas/instances/backups/get/help.md | 28 ++++++++ docs/dbaas/instances/backups/help.md | 27 ++++++++ docs/dbaas/instances/backups/list/help.md | 31 +++++++++ docs/dbaas/instances/create/help.md | 43 ++++++++++++ docs/dbaas/instances/delete/help.md | 26 +++++++ docs/dbaas/instances/get/help.md | 28 ++++++++ docs/dbaas/instances/help.md | 33 +++++++++ docs/dbaas/instances/list/help.md | 36 ++++++++++ docs/dbaas/instances/resize/help.md | 35 ++++++++++ docs/dbaas/instances/restores/help.md | 28 ++++++++ docs/dbaas/instances/start/help.md | 27 ++++++++ docs/dbaas/instances/stop/help.md | 27 ++++++++ docs/dbaas/instances/update/help.md | 31 +++++++++ docs/dbaas/replicas/create/help.md | 29 ++++++++ docs/dbaas/replicas/delete/help.md | 26 +++++++ docs/dbaas/replicas/get/help.md | 27 ++++++++ docs/dbaas/replicas/help.md | 30 ++++++++ docs/dbaas/replicas/list/help.md | 28 ++++++++ docs/dbaas/replicas/resize/help.md | 29 ++++++++ docs/dbaas/replicas/start/help.md | 27 ++++++++ docs/dbaas/replicas/stop/help.md | 27 ++++++++ docs/help.md | 37 ++++++++++ docs/http/do/help.md | 28 ++++++++ docs/http/help.md | 24 +++++++ docs/http/json/delete/help.md | 26 +++++++ docs/http/json/get/help.md | 26 +++++++ docs/http/json/head/help.md | 26 +++++++ docs/http/json/help.md | 30 ++++++++ docs/http/json/options/help.md | 28 ++++++++ docs/http/json/patch/help.md | 28 ++++++++ docs/http/json/post/help.md | 28 ++++++++ docs/http/json/put/help.md | 28 ++++++++ docs/http/json/trace/help.md | 26 +++++++ docs/kubernetes/cluster/create/help.md | 49 +++++++++++++ docs/kubernetes/cluster/delete/help.md | 26 +++++++ docs/kubernetes/cluster/get/help.md | 27 ++++++++ docs/kubernetes/cluster/help.md | 28 ++++++++ docs/kubernetes/cluster/kubeconfig/help.md | 27 ++++++++ docs/kubernetes/cluster/list/help.md | 25 +++++++ docs/kubernetes/flavor/help.md | 24 +++++++ docs/kubernetes/flavor/list/help.md | 25 +++++++ docs/kubernetes/help.md | 28 ++++++++ docs/kubernetes/info/flavors/help.md | 25 +++++++ docs/kubernetes/info/help.md | 25 +++++++ docs/kubernetes/info/versions/help.md | 25 +++++++ docs/kubernetes/nodepool/create/help.md | 69 +++++++++++++++++++ docs/kubernetes/nodepool/delete/help.md | 27 ++++++++ docs/kubernetes/nodepool/get/help.md | 28 ++++++++ docs/kubernetes/nodepool/help.md | 29 ++++++++ docs/kubernetes/nodepool/list/help.md | 26 +++++++ docs/kubernetes/nodepool/nodes/help.md | 28 ++++++++ docs/kubernetes/nodepool/update/help.md | 39 +++++++++++ docs/kubernetes/version/help.md | 24 +++++++ docs/kubernetes/version/list/help.md | 25 +++++++ docs/network/healthcheck/help.md | 24 +++++++ docs/network/healthcheck/list/help.md | 25 +++++++ docs/network/help.md | 29 ++++++++ docs/network/ports/attach/help.md | 28 ++++++++ docs/network/ports/create-default-vpc/help.md | 32 +++++++++ docs/network/ports/create/help.md | 33 +++++++++ docs/network/ports/delete-all/help.md | 25 +++++++ docs/network/ports/delete/help.md | 26 +++++++ docs/network/ports/detach/help.md | 28 ++++++++ docs/network/ports/get/help.md | 27 ++++++++ docs/network/ports/help.md | 29 ++++++++ docs/network/ports/list/help.md | 26 +++++++ .../security-group-attachment/create/help.md | 27 ++++++++ .../security-group-attachment/delete/help.md | 26 +++++++ .../security-group-attachment/get/help.md | 26 +++++++ .../ports/security-group-attachment/help.md | 25 +++++++ docs/network/public_ips/attach/help.md | 28 ++++++++ docs/network/public_ips/create/help.md | 31 +++++++++ docs/network/public_ips/delete/help.md | 26 +++++++ docs/network/public_ips/detach/help.md | 28 ++++++++ docs/network/public_ips/get/help.md | 27 ++++++++ docs/network/public_ips/help.md | 29 ++++++++ docs/network/public_ips/list/help.md | 25 +++++++ .../public_ips/port-attachment/create/help.md | 27 ++++++++ .../public_ips/port-attachment/delete/help.md | 26 +++++++ .../public_ips/port-attachment/get/help.md | 26 +++++++ .../public_ips/port-attachment/help.md | 25 +++++++ docs/network/quotas/help.md | 22 ++++++ docs/network/quotas/list/help.md | 26 +++++++ docs/network/rules/create/help.md | 37 ++++++++++ docs/network/rules/delete/help.md | 26 +++++++ docs/network/rules/get/help.md | 27 ++++++++ docs/network/rules/help.md | 27 ++++++++ docs/network/rules/list/help.md | 26 +++++++ .../security_groups/create-default/help.md | 26 +++++++ docs/network/security_groups/create/help.md | 31 +++++++++ .../security_groups/delete-all/help.md | 25 +++++++ docs/network/security_groups/delete/help.md | 26 +++++++ docs/network/security_groups/get/help.md | 27 ++++++++ docs/network/security_groups/help.md | 27 ++++++++ docs/network/security_groups/list/help.md | 25 +++++++ .../security_groups/rules/create/help.md | 37 ++++++++++ docs/network/security_groups/rules/help.md | 22 ++++++ .../security_groups/rules/list/help.md | 26 +++++++ docs/network/subnets/help.md | 24 +++++++ docs/network/subnets/subnets/delete/help.md | 26 +++++++ docs/network/subnets/subnets/get/help.md | 27 ++++++++ docs/network/subnets/subnets/help.md | 26 +++++++ docs/network/subnets/subnets/update/help.md | 29 ++++++++ .../subnets/vpcs-subnets/create/help.md | 33 +++++++++ docs/network/subnets/vpcs-subnets/help.md | 22 ++++++ .../network/subnets/vpcs-subnets/list/help.md | 26 +++++++ docs/network/vpcs/create-default/help.md | 26 +++++++ docs/network/vpcs/create/help.md | 28 ++++++++ docs/network/vpcs/delete-all/help.md | 25 +++++++ docs/network/vpcs/delete/help.md | 26 +++++++ docs/network/vpcs/get/help.md | 27 ++++++++ docs/network/vpcs/help.md | 29 ++++++++ docs/network/vpcs/list/help.md | 25 +++++++ docs/network/vpcs/ports/create/help.md | 33 +++++++++ docs/network/vpcs/ports/help.md | 25 +++++++ docs/network/vpcs/ports/list/help.md | 30 ++++++++ docs/network/vpcs/public-ips/create/help.md | 31 +++++++++ docs/network/vpcs/public-ips/help.md | 24 +++++++ docs/network/vpcs/public-ips/list/help.md | 26 +++++++ .../vpcs/security-groups/create/help.md | 31 +++++++++ docs/network/vpcs/security-groups/help.md | 22 ++++++ .../network/vpcs/security-groups/list/help.md | 26 +++++++ docs/network/worker_public_ips/help.md | 23 +++++++ docs/network/worker_public_ips/update/help.md | 30 ++++++++ docs/object-storage/api-key/add/help.md | 23 +++++++ docs/object-storage/api-key/create/help.md | 25 +++++++ docs/object-storage/api-key/current/help.md | 21 ++++++ docs/object-storage/api-key/get/help.md | 22 ++++++ docs/object-storage/api-key/help.md | 28 ++++++++ docs/object-storage/api-key/list/help.md | 21 ++++++ docs/object-storage/api-key/revoke/help.md | 22 ++++++ docs/object-storage/api-key/set/help.md | 22 ++++++ docs/object-storage/buckets/acl/get/help.md | 26 +++++++ docs/object-storage/buckets/acl/help.md | 24 +++++++ docs/object-storage/buckets/acl/set/help.md | 31 +++++++++ docs/object-storage/buckets/create/help.md | 32 +++++++++ docs/object-storage/buckets/delete/help.md | 27 ++++++++ docs/object-storage/buckets/get/help.md | 26 +++++++ docs/object-storage/buckets/help.md | 28 ++++++++ docs/object-storage/buckets/list/help.md | 25 +++++++ .../object-storage/buckets/public-url/help.md | 27 ++++++++ .../buckets/versioning/enable/help.md | 26 +++++++ .../buckets/versioning/get/help.md | 26 +++++++ .../object-storage/buckets/versioning/help.md | 25 +++++++ .../buckets/versioning/suspend/help.md | 26 +++++++ docs/object-storage/help.md | 25 +++++++ docs/object-storage/objects/acl/get/help.md | 26 +++++++ docs/object-storage/objects/acl/help.md | 24 +++++++ docs/object-storage/objects/acl/set/help.md | 30 ++++++++ docs/object-storage/objects/copy-all/help.md | 31 +++++++++ docs/object-storage/objects/copy/help.md | 30 ++++++++ .../object-storage/objects/delete-all/help.md | 29 ++++++++ docs/object-storage/objects/delete/help.md | 28 ++++++++ .../objects/download-all/help.md | 30 ++++++++ docs/object-storage/objects/download/help.md | 29 ++++++++ docs/object-storage/objects/head/help.md | 28 ++++++++ docs/object-storage/objects/help.md | 39 +++++++++++ docs/object-storage/objects/list/help.md | 32 +++++++++ docs/object-storage/objects/move-dir/help.md | 30 ++++++++ docs/object-storage/objects/move/help.md | 29 ++++++++ docs/object-storage/objects/presign/help.md | 29 ++++++++ .../object-storage/objects/public-url/help.md | 27 ++++++++ docs/object-storage/objects/sync/help.md | 30 ++++++++ .../object-storage/objects/upload-dir/help.md | 32 +++++++++ docs/object-storage/objects/upload/help.md | 29 ++++++++ docs/object-storage/objects/versions/help.md | 27 ++++++++ docs/profile/create/help.md | 23 +++++++ docs/profile/delete/help.md | 22 ++++++ docs/profile/get/help.md | 21 ++++++ docs/profile/help.md | 29 ++++++++ docs/profile/list/help.md | 21 ++++++ docs/profile/set/help.md | 22 ++++++ docs/virtual-machine/help.md | 27 ++++++++ docs/virtual-machine/images/help.md | 24 +++++++ docs/virtual-machine/images/list/help.md | 28 ++++++++ docs/virtual-machine/instances/create/help.md | 63 +++++++++++++++++ docs/virtual-machine/instances/delete/help.md | 27 ++++++++ docs/virtual-machine/instances/get/help.md | 28 ++++++++ docs/virtual-machine/instances/help.md | 34 +++++++++ docs/virtual-machine/instances/list/help.md | 29 ++++++++ .../network-interface/attach/help.md | 39 +++++++++++ .../network-interface/detach/help.md | 39 +++++++++++ .../instances/network-interface/help.md | 25 +++++++ docs/virtual-machine/instances/reboot/help.md | 32 +++++++++ docs/virtual-machine/instances/rename/help.md | 31 +++++++++ docs/virtual-machine/instances/retype/help.md | 28 ++++++++ docs/virtual-machine/instances/start/help.md | 32 +++++++++ docs/virtual-machine/instances/stop/help.md | 32 +++++++++ .../virtual-machine/instances/suspend/help.md | 27 ++++++++ docs/virtual-machine/machine-types/help.md | 24 +++++++ .../machine-types/list/help.md | 28 ++++++++ docs/virtual-machine/snapshots/create/help.md | 26 +++++++ docs/virtual-machine/snapshots/delete/help.md | 29 ++++++++ docs/virtual-machine/snapshots/get/help.md | 27 ++++++++ docs/virtual-machine/snapshots/help.md | 29 ++++++++ docs/virtual-machine/snapshots/list/help.md | 31 +++++++++ docs/virtual-machine/snapshots/rename/help.md | 31 +++++++++ .../virtual-machine/snapshots/restore/help.md | 26 +++++++ 272 files changed, 7571 insertions(+) create mode 100644 .github/workflows/wiki.yaml create mode 100644 docs/auth/access_token/help.md create mode 100644 docs/auth/clients/create/help.md create mode 100644 docs/auth/clients/help.md create mode 100644 docs/auth/clients/list/help.md create mode 100644 docs/auth/clients/update/help.md create mode 100644 docs/auth/help.md create mode 100644 docs/auth/login/help.md create mode 100644 docs/auth/tenant/current/help.md create mode 100644 docs/auth/tenant/help.md create mode 100644 docs/auth/tenant/list/help.md create mode 100644 docs/auth/tenant/set/help.md create mode 100644 docs/block-storage/help.md create mode 100644 docs/block-storage/snapshots/create/help.md create mode 100644 docs/block-storage/snapshots/delete/help.md create mode 100644 docs/block-storage/snapshots/get/help.md create mode 100644 docs/block-storage/snapshots/help.md create mode 100644 docs/block-storage/snapshots/list/help.md create mode 100644 docs/block-storage/snapshots/rename/help.md create mode 100644 docs/block-storage/snapshots/restore/help.md create mode 100644 docs/block-storage/volume-attachment/create/help.md create mode 100644 docs/block-storage/volume-attachment/delete/help.md create mode 100644 docs/block-storage/volume-attachment/get/help.md create mode 100644 docs/block-storage/volume-attachment/help.md create mode 100644 docs/block-storage/volume-types/help.md create mode 100644 docs/block-storage/volume-types/list/help.md create mode 100644 docs/block-storage/volumes/attach/help.md create mode 100644 docs/block-storage/volumes/create/help.md create mode 100644 docs/block-storage/volumes/delete/help.md create mode 100644 docs/block-storage/volumes/detach/help.md create mode 100644 docs/block-storage/volumes/extend/help.md create mode 100644 docs/block-storage/volumes/get/help.md create mode 100644 docs/block-storage/volumes/help.md create mode 100644 docs/block-storage/volumes/list/help.md create mode 100644 docs/block-storage/volumes/rename/help.md create mode 100644 docs/block-storage/volumes/retype/help.md create mode 100644 docs/config/delete/help.md create mode 100644 docs/config/get-schema/help.md create mode 100644 docs/config/get/help.md create mode 100644 docs/config/help.md create mode 100644 docs/config/list/help.md create mode 100644 docs/config/set/help.md create mode 100644 docs/container-registry/credentials/help.md create mode 100644 docs/container-registry/credentials/list/help.md create mode 100644 docs/container-registry/help.md create mode 100644 docs/container-registry/images/delete/help.md create mode 100644 docs/container-registry/images/get/help.md create mode 100644 docs/container-registry/images/help.md create mode 100644 docs/container-registry/images/list/help.md create mode 100644 docs/container-registry/registries/create/help.md create mode 100644 docs/container-registry/registries/delete/help.md create mode 100644 docs/container-registry/registries/get/help.md create mode 100644 docs/container-registry/registries/help.md create mode 100644 docs/container-registry/registries/list/help.md create mode 100644 docs/container-registry/repositories/delete/help.md create mode 100644 docs/container-registry/repositories/get/help.md create mode 100644 docs/container-registry/repositories/help.md create mode 100644 docs/container-registry/repositories/list/help.md create mode 100644 docs/dbaas/backups/delete/help.md create mode 100644 docs/dbaas/backups/get/help.md create mode 100644 docs/dbaas/backups/help.md create mode 100644 docs/dbaas/backups/list/help.md create mode 100644 docs/dbaas/datastores/get/help.md create mode 100644 docs/dbaas/datastores/help.md create mode 100644 docs/dbaas/datastores/list/help.md create mode 100644 docs/dbaas/engines/get/help.md create mode 100644 docs/dbaas/engines/help.md create mode 100644 docs/dbaas/engines/list/help.md create mode 100644 docs/dbaas/flavors/get/help.md create mode 100644 docs/dbaas/flavors/help.md create mode 100644 docs/dbaas/flavors/list/help.md create mode 100644 docs/dbaas/help.md create mode 100644 docs/dbaas/instances/backups/create/help.md create mode 100644 docs/dbaas/instances/backups/delete/help.md create mode 100644 docs/dbaas/instances/backups/get/help.md create mode 100644 docs/dbaas/instances/backups/help.md create mode 100644 docs/dbaas/instances/backups/list/help.md create mode 100644 docs/dbaas/instances/create/help.md create mode 100644 docs/dbaas/instances/delete/help.md create mode 100644 docs/dbaas/instances/get/help.md create mode 100644 docs/dbaas/instances/help.md create mode 100644 docs/dbaas/instances/list/help.md create mode 100644 docs/dbaas/instances/resize/help.md create mode 100644 docs/dbaas/instances/restores/help.md create mode 100644 docs/dbaas/instances/start/help.md create mode 100644 docs/dbaas/instances/stop/help.md create mode 100644 docs/dbaas/instances/update/help.md create mode 100644 docs/dbaas/replicas/create/help.md create mode 100644 docs/dbaas/replicas/delete/help.md create mode 100644 docs/dbaas/replicas/get/help.md create mode 100644 docs/dbaas/replicas/help.md create mode 100644 docs/dbaas/replicas/list/help.md create mode 100644 docs/dbaas/replicas/resize/help.md create mode 100644 docs/dbaas/replicas/start/help.md create mode 100644 docs/dbaas/replicas/stop/help.md create mode 100644 docs/help.md create mode 100644 docs/http/do/help.md create mode 100644 docs/http/help.md create mode 100644 docs/http/json/delete/help.md create mode 100644 docs/http/json/get/help.md create mode 100644 docs/http/json/head/help.md create mode 100644 docs/http/json/help.md create mode 100644 docs/http/json/options/help.md create mode 100644 docs/http/json/patch/help.md create mode 100644 docs/http/json/post/help.md create mode 100644 docs/http/json/put/help.md create mode 100644 docs/http/json/trace/help.md create mode 100644 docs/kubernetes/cluster/create/help.md create mode 100644 docs/kubernetes/cluster/delete/help.md create mode 100644 docs/kubernetes/cluster/get/help.md create mode 100644 docs/kubernetes/cluster/help.md create mode 100644 docs/kubernetes/cluster/kubeconfig/help.md create mode 100644 docs/kubernetes/cluster/list/help.md create mode 100644 docs/kubernetes/flavor/help.md create mode 100644 docs/kubernetes/flavor/list/help.md create mode 100644 docs/kubernetes/help.md create mode 100644 docs/kubernetes/info/flavors/help.md create mode 100644 docs/kubernetes/info/help.md create mode 100644 docs/kubernetes/info/versions/help.md create mode 100644 docs/kubernetes/nodepool/create/help.md create mode 100644 docs/kubernetes/nodepool/delete/help.md create mode 100644 docs/kubernetes/nodepool/get/help.md create mode 100644 docs/kubernetes/nodepool/help.md create mode 100644 docs/kubernetes/nodepool/list/help.md create mode 100644 docs/kubernetes/nodepool/nodes/help.md create mode 100644 docs/kubernetes/nodepool/update/help.md create mode 100644 docs/kubernetes/version/help.md create mode 100644 docs/kubernetes/version/list/help.md create mode 100644 docs/network/healthcheck/help.md create mode 100644 docs/network/healthcheck/list/help.md create mode 100644 docs/network/help.md create mode 100644 docs/network/ports/attach/help.md create mode 100644 docs/network/ports/create-default-vpc/help.md create mode 100644 docs/network/ports/create/help.md create mode 100644 docs/network/ports/delete-all/help.md create mode 100644 docs/network/ports/delete/help.md create mode 100644 docs/network/ports/detach/help.md create mode 100644 docs/network/ports/get/help.md create mode 100644 docs/network/ports/help.md create mode 100644 docs/network/ports/list/help.md create mode 100644 docs/network/ports/security-group-attachment/create/help.md create mode 100644 docs/network/ports/security-group-attachment/delete/help.md create mode 100644 docs/network/ports/security-group-attachment/get/help.md create mode 100644 docs/network/ports/security-group-attachment/help.md create mode 100644 docs/network/public_ips/attach/help.md create mode 100644 docs/network/public_ips/create/help.md create mode 100644 docs/network/public_ips/delete/help.md create mode 100644 docs/network/public_ips/detach/help.md create mode 100644 docs/network/public_ips/get/help.md create mode 100644 docs/network/public_ips/help.md create mode 100644 docs/network/public_ips/list/help.md create mode 100644 docs/network/public_ips/port-attachment/create/help.md create mode 100644 docs/network/public_ips/port-attachment/delete/help.md create mode 100644 docs/network/public_ips/port-attachment/get/help.md create mode 100644 docs/network/public_ips/port-attachment/help.md create mode 100644 docs/network/quotas/help.md create mode 100644 docs/network/quotas/list/help.md create mode 100644 docs/network/rules/create/help.md create mode 100644 docs/network/rules/delete/help.md create mode 100644 docs/network/rules/get/help.md create mode 100644 docs/network/rules/help.md create mode 100644 docs/network/rules/list/help.md create mode 100644 docs/network/security_groups/create-default/help.md create mode 100644 docs/network/security_groups/create/help.md create mode 100644 docs/network/security_groups/delete-all/help.md create mode 100644 docs/network/security_groups/delete/help.md create mode 100644 docs/network/security_groups/get/help.md create mode 100644 docs/network/security_groups/help.md create mode 100644 docs/network/security_groups/list/help.md create mode 100644 docs/network/security_groups/rules/create/help.md create mode 100644 docs/network/security_groups/rules/help.md create mode 100644 docs/network/security_groups/rules/list/help.md create mode 100644 docs/network/subnets/help.md create mode 100644 docs/network/subnets/subnets/delete/help.md create mode 100644 docs/network/subnets/subnets/get/help.md create mode 100644 docs/network/subnets/subnets/help.md create mode 100644 docs/network/subnets/subnets/update/help.md create mode 100644 docs/network/subnets/vpcs-subnets/create/help.md create mode 100644 docs/network/subnets/vpcs-subnets/help.md create mode 100644 docs/network/subnets/vpcs-subnets/list/help.md create mode 100644 docs/network/vpcs/create-default/help.md create mode 100644 docs/network/vpcs/create/help.md create mode 100644 docs/network/vpcs/delete-all/help.md create mode 100644 docs/network/vpcs/delete/help.md create mode 100644 docs/network/vpcs/get/help.md create mode 100644 docs/network/vpcs/help.md create mode 100644 docs/network/vpcs/list/help.md create mode 100644 docs/network/vpcs/ports/create/help.md create mode 100644 docs/network/vpcs/ports/help.md create mode 100644 docs/network/vpcs/ports/list/help.md create mode 100644 docs/network/vpcs/public-ips/create/help.md create mode 100644 docs/network/vpcs/public-ips/help.md create mode 100644 docs/network/vpcs/public-ips/list/help.md create mode 100644 docs/network/vpcs/security-groups/create/help.md create mode 100644 docs/network/vpcs/security-groups/help.md create mode 100644 docs/network/vpcs/security-groups/list/help.md create mode 100644 docs/network/worker_public_ips/help.md create mode 100644 docs/network/worker_public_ips/update/help.md create mode 100644 docs/object-storage/api-key/add/help.md create mode 100644 docs/object-storage/api-key/create/help.md create mode 100644 docs/object-storage/api-key/current/help.md create mode 100644 docs/object-storage/api-key/get/help.md create mode 100644 docs/object-storage/api-key/help.md create mode 100644 docs/object-storage/api-key/list/help.md create mode 100644 docs/object-storage/api-key/revoke/help.md create mode 100644 docs/object-storage/api-key/set/help.md create mode 100644 docs/object-storage/buckets/acl/get/help.md create mode 100644 docs/object-storage/buckets/acl/help.md create mode 100644 docs/object-storage/buckets/acl/set/help.md create mode 100644 docs/object-storage/buckets/create/help.md create mode 100644 docs/object-storage/buckets/delete/help.md create mode 100644 docs/object-storage/buckets/get/help.md create mode 100644 docs/object-storage/buckets/help.md create mode 100644 docs/object-storage/buckets/list/help.md create mode 100644 docs/object-storage/buckets/public-url/help.md create mode 100644 docs/object-storage/buckets/versioning/enable/help.md create mode 100644 docs/object-storage/buckets/versioning/get/help.md create mode 100644 docs/object-storage/buckets/versioning/help.md create mode 100644 docs/object-storage/buckets/versioning/suspend/help.md create mode 100644 docs/object-storage/help.md create mode 100644 docs/object-storage/objects/acl/get/help.md create mode 100644 docs/object-storage/objects/acl/help.md create mode 100644 docs/object-storage/objects/acl/set/help.md create mode 100644 docs/object-storage/objects/copy-all/help.md create mode 100644 docs/object-storage/objects/copy/help.md create mode 100644 docs/object-storage/objects/delete-all/help.md create mode 100644 docs/object-storage/objects/delete/help.md create mode 100644 docs/object-storage/objects/download-all/help.md create mode 100644 docs/object-storage/objects/download/help.md create mode 100644 docs/object-storage/objects/head/help.md create mode 100644 docs/object-storage/objects/help.md create mode 100644 docs/object-storage/objects/list/help.md create mode 100644 docs/object-storage/objects/move-dir/help.md create mode 100644 docs/object-storage/objects/move/help.md create mode 100644 docs/object-storage/objects/presign/help.md create mode 100644 docs/object-storage/objects/public-url/help.md create mode 100644 docs/object-storage/objects/sync/help.md create mode 100644 docs/object-storage/objects/upload-dir/help.md create mode 100644 docs/object-storage/objects/upload/help.md create mode 100644 docs/object-storage/objects/versions/help.md create mode 100644 docs/profile/create/help.md create mode 100644 docs/profile/delete/help.md create mode 100644 docs/profile/get/help.md create mode 100644 docs/profile/help.md create mode 100644 docs/profile/list/help.md create mode 100644 docs/profile/set/help.md create mode 100644 docs/virtual-machine/help.md create mode 100644 docs/virtual-machine/images/help.md create mode 100644 docs/virtual-machine/images/list/help.md create mode 100644 docs/virtual-machine/instances/create/help.md create mode 100644 docs/virtual-machine/instances/delete/help.md create mode 100644 docs/virtual-machine/instances/get/help.md create mode 100644 docs/virtual-machine/instances/help.md create mode 100644 docs/virtual-machine/instances/list/help.md create mode 100644 docs/virtual-machine/instances/network-interface/attach/help.md create mode 100644 docs/virtual-machine/instances/network-interface/detach/help.md create mode 100644 docs/virtual-machine/instances/network-interface/help.md create mode 100644 docs/virtual-machine/instances/reboot/help.md create mode 100644 docs/virtual-machine/instances/rename/help.md create mode 100644 docs/virtual-machine/instances/retype/help.md create mode 100644 docs/virtual-machine/instances/start/help.md create mode 100644 docs/virtual-machine/instances/stop/help.md create mode 100644 docs/virtual-machine/instances/suspend/help.md create mode 100644 docs/virtual-machine/machine-types/help.md create mode 100644 docs/virtual-machine/machine-types/list/help.md create mode 100644 docs/virtual-machine/snapshots/create/help.md create mode 100644 docs/virtual-machine/snapshots/delete/help.md create mode 100644 docs/virtual-machine/snapshots/get/help.md create mode 100644 docs/virtual-machine/snapshots/help.md create mode 100644 docs/virtual-machine/snapshots/list/help.md create mode 100644 docs/virtual-machine/snapshots/rename/help.md create mode 100644 docs/virtual-machine/snapshots/restore/help.md diff --git a/.github/workflows/wiki.yaml b/.github/workflows/wiki.yaml new file mode 100644 index 0000000..f7bcb8c --- /dev/null +++ b/.github/workflows/wiki.yaml @@ -0,0 +1,18 @@ +name: Publish wiki +on: + push: + branches: [main] +concurrency: + group: publish-wiki + cancel-in-progress: true +permissions: + contents: write +jobs: + publish-wiki: + name: Publish wiki + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: Andrew-Chen-Wang/github-wiki-action@v4 + with: + WIKI_PATH: docs/ \ No newline at end of file diff --git a/docs/auth/access_token/help.md b/docs/auth/access_token/help.md new file mode 100644 index 0000000..275c7ff --- /dev/null +++ b/docs/auth/access_token/help.md @@ -0,0 +1,23 @@ +# Retrieve the access token used in the APIs + +## Usage: +```bash +Usage: + ./mgc auth access-token [flags] +``` + +## Product catalog: +- Aliases: +- access-token, access_token + +## Other commands: +- Flags: +- -h, --help help for access-token +- --validate Validate the token, refreshing if needed + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/auth/clients/create/help.md b/docs/auth/clients/create/help.md new file mode 100644 index 0000000..7ee6a5a --- /dev/null +++ b/docs/auth/clients/create/help.md @@ -0,0 +1,37 @@ +# Create new client (Oauth Application) + +## Usage: +```bash +Usage: + ./mgc auth clients create [name] [description] [redirect-uris] [icon] [access-token-expiration] [always-require-login] [client-privacy-term-url] [terms-of-use] [audiences] [backchannel-logout-session-enabled] [backchannel-logout-uri] [oidc-audiences] [refresh-token-custom-expires-enabled] [refresh-token-expiration] [reason] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc auth clients create --access-token-expiration=7200 --audiences="public" --description="Client description" --name="Client Name" --refresh-token-expiration=15778476 + +## Other commands: +- Flags: +- --access-token-expiration integer Access token expiration (in seconds) +- --always-require-login Must ignore active Magalu ID session and always require login +- --audiences string Client audiences (separated by space) +- --backchannel-logout-session-enabled Client requires backchannel logout session +- --backchannel-logout-uri string Backchannel logout URI +- --client-privacy-term-url string URL to privacy term (required) +- --description string Description of new client (required) +- -h, --help help for create +- --icon string URL for client icon +- --name string Name of new client (required) +- --oidc-audiences string Audiences for ID token +- --reason string Note to inform the reason for creating the client. Will help with the application approval process (required) +- --redirect-uris string Redirect URIs (separated by space) (required) +- --refresh-token-custom-expires-enabled Use custom value for refresh token expiration +- --refresh-token-expiration integer Custom refresh token expiration value (in seconds) +- --terms-of-use string URL to terms of use (required) + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/auth/clients/help.md b/docs/auth/clients/help.md new file mode 100644 index 0000000..e131bfa --- /dev/null +++ b/docs/auth/clients/help.md @@ -0,0 +1,25 @@ +# Manage Clients (Oauth Applications) to use ID Magalu + +## Usage: +```bash +Usage: + ./mgc auth clients [flags] + ./mgc auth clients [command] +``` + +## Product catalog: +- Commands: +- create Create new client (Oauth Application) +- list List user clients +- update Update a client (Oauth Application) + +## Other commands: +- Flags: +- -h, --help help for clients + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/auth/clients/list/help.md b/docs/auth/clients/list/help.md new file mode 100644 index 0000000..da1dc88 --- /dev/null +++ b/docs/auth/clients/list/help.md @@ -0,0 +1,21 @@ +# List user clients + +## Usage: +```bash +Usage: + ./mgc auth clients list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/auth/clients/update/help.md b/docs/auth/clients/update/help.md new file mode 100644 index 0000000..c4dec9b --- /dev/null +++ b/docs/auth/clients/update/help.md @@ -0,0 +1,38 @@ +# Update a client (Oauth Application) + +## Usage: +```bash +Usage: + ./mgc auth clients update [id] [name] [description] [redirect-uris] [icon] [access-token-expiration] [always-require-login] [client-privacy-term-url] [terms-of-use] [audiences] [backchannel-logout-session-enabled] [backchannel-logout-uri] [oidc-audiences] [refresh-token-custom-expires-enabled] [refresh-token-expiration] [reason] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc auth clients update --access-token-expiration=7200 --audiences="public" --description="Client description" --name="Client Name" --refresh-token-expiration=15778476 + +## Other commands: +- Flags: +- --access-token-expiration integer Access token expiration (in seconds) +- --always-require-login Must ignore active Magalu ID session and always require login +- --audiences string Client audiences (separated by space) +- --backchannel-logout-session-enabled Client requires backchannel logout session +- --backchannel-logout-uri string Backchannel logout URI +- --client-privacy-term-url string URL to privacy term +- --description string Description of new client +- -h, --help help for update +- --icon string URL for client icon +- --id string UUID of client (required) +- --name string Name of new client +- --oidc-audiences string Audiences for ID token +- --reason string Note to inform the reason for creating the client. Will help with the application approval process +- --redirect-uris string Redirect URIs (separated by space) +- --refresh-token-custom-expires-enabled Use custom value for refresh token expiration +- --refresh-token-expiration integer Custom refresh token expiration value (in seconds) +- --terms-of-use string URL to terms of use + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/auth/help.md b/docs/auth/help.md new file mode 100644 index 0000000..0aa03de --- /dev/null +++ b/docs/auth/help.md @@ -0,0 +1,28 @@ +# The authentication credentials set here will be used as a basis for a variety +of HTTP requests using the MgcSDK. Authentication is done via Magalu Cloud account +(Object Storage requires special keys, refer to it for more info) + +## Usage: +```bash +Usage: + ./mgc auth [flags] + ./mgc auth [command] +``` + +## Product catalog: +- Commands: +- access-token Retrieve the access token used in the APIs +- clients Manage Clients (Oauth Applications) to use ID Magalu +- login Authenticate with Magalu Cloud +- tenant Manage Tenants + +## Other commands: +- Flags: +- -h, --help help for auth + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/auth/login/help.md b/docs/auth/login/help.md new file mode 100644 index 0000000..715adc5 --- /dev/null +++ b/docs/auth/login/help.md @@ -0,0 +1,27 @@ +# Log in to your Magalu Cloud account. When you login with this command, +the current Tenant will always be set to the default one. To see more details +about a successful login, use the '--show' flag when logging in + +## Usage: +```bash +Usage: + ./mgc auth login [flags] +``` + +## Product catalog: +- Flags: +- --headless Generate URL for the login at local environment +- -h, --help help for login +- --qrcode Generate a qrcode for the login URL +- --scopes array(string) All desired scopes for the resulting access token +- --show Show the access token after the login completes + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/auth/tenant/current/help.md b/docs/auth/tenant/current/help.md new file mode 100644 index 0000000..0a3fea7 --- /dev/null +++ b/docs/auth/tenant/current/help.md @@ -0,0 +1,21 @@ +# The current Tenant is used for all Magalu HTTP requests + +## Usage: +```bash +Usage: + ./mgc auth tenant current [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for current + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/auth/tenant/help.md b/docs/auth/tenant/help.md new file mode 100644 index 0000000..75bcc79 --- /dev/null +++ b/docs/auth/tenant/help.md @@ -0,0 +1,27 @@ +# Tenants work like sub-accounts. You may have more than one Tenant under your +Magalu Cloud account and they each store their data separately, but are billed +under the same account + +## Usage: +```bash +Usage: + ./mgc auth tenant [flags] + ./mgc auth tenant [command] +``` + +## Product catalog: +- Commands: +- current Get the currently active Tenant +- list List all available tenants for current login +- set Set the active Tenant to be used for all subsequent requests + +## Other commands: +- Additional Commands: +- select call "list", prompt selection and then "set" + +## Flags: +```bash +Flags: + -h, --help help for tenant +``` + diff --git a/docs/auth/tenant/list/help.md b/docs/auth/tenant/list/help.md new file mode 100644 index 0000000..4ec252a --- /dev/null +++ b/docs/auth/tenant/list/help.md @@ -0,0 +1,21 @@ +# List all available tenants for current login + +## Usage: +```bash +Usage: + ./mgc auth tenant list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/auth/tenant/set/help.md b/docs/auth/tenant/set/help.md new file mode 100644 index 0000000..52e50b0 --- /dev/null +++ b/docs/auth/tenant/set/help.md @@ -0,0 +1,22 @@ +# Set the active Tenant to be used for all subsequent requests + +## Usage: +```bash +Usage: + ./mgc auth tenant set [uuid] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for set +- --uuid string The UUID of the desired Tenant. To list all possible IDs, run auth tenant list (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash +** If you have an API Key set, changing the tenant will unset it. +``` + diff --git a/docs/block-storage/help.md b/docs/block-storage/help.md new file mode 100644 index 0000000..21f8df7 --- /dev/null +++ b/docs/block-storage/help.md @@ -0,0 +1,26 @@ +# Block Storage API Product Documentation + +## Usage: +```bash +Usage: + ./mgc block-storage [flags] + ./mgc block-storage [command] +``` + +## Product catalog: +- Aliases: +- block-storage, bs, blocks, blst + +## Other commands: +- Commands: +- snapshots Operations with snapshots for volumes. +- volume-types Operations with volume types for volumes. +- volumes Operations with volumes, including create, delete, extend, retype, list and other actions. + +## Flags: +```bash +Flags: + -h, --help help for block-storage + -v, --version version for block-storage +``` + diff --git a/docs/block-storage/snapshots/create/help.md b/docs/block-storage/snapshots/create/help.md new file mode 100644 index 0000000..8c47b00 --- /dev/null +++ b/docs/block-storage/snapshots/create/help.md @@ -0,0 +1,27 @@ +# Create a Snapshot for the currently authenticated tenant. + +## Usage: +```bash +The Snapshot can be used when it reaches the "available" state and the + "completed" status. +``` + +## Product catalog: +- #### Rules +- - The Snapshot name must be unique; otherwise, the creation will be disallowed. +- - Creating Snapshots from restored Volumes may lead to future conflicts as +- you can't delete a Volume with an Snapshot and can't delete a Snapshot with a +- restored Volume, so we recommend avoiding it. + +## Other commands: +- #### Notes +- - Use the **block-storage volume list** command to retrieve a list of all +- Volumes and obtain the ID of the Volume that will be used to create the +- Snapshot. + +## Flags: +```bash +Usage: + ./mgc block-storage snapshots create [flags] +``` + diff --git a/docs/block-storage/snapshots/delete/help.md b/docs/block-storage/snapshots/delete/help.md new file mode 100644 index 0000000..daf8dc0 --- /dev/null +++ b/docs/block-storage/snapshots/delete/help.md @@ -0,0 +1,30 @@ +# Delete a Snapshot for the currently authenticated tenant. + +## Usage: +```bash +#### Rules +- The Snapshot's status must be "completed". +- The Snapshot's state must be "available". +- Deleting a Snapshot that has been restored is not possible. If necessary, + delete the restored Volume first and then proceed to delete the Snapshot. +``` + +## Product catalog: +- #### Notes +- - Utilize the **block-storage snapshots** list command to retrieve a list of +- all Snapshots and obtain the ID of the Snapshot you wish to delete. +- - If needed, you can use the **block-storage volume list** command to retrieve +- a list of all Volumes and obtain the ID of the restored Volume. + +## Other commands: +- Usage: +- ./mgc block-storage snapshots delete [id] [flags] + +## Flags: +```bash +Flags: + -h, --help help for delete + --id uuid Id (required) + -v, --version version for delete +``` + diff --git a/docs/block-storage/snapshots/get/help.md b/docs/block-storage/snapshots/get/help.md new file mode 100644 index 0000000..613ab31 --- /dev/null +++ b/docs/block-storage/snapshots/get/help.md @@ -0,0 +1,33 @@ +# Retrieve details of a Snapshot for the currently authenticated tenant. + +## Usage: +```bash +#### Notes +- Use the **expand** argument to obtain additional details about the Volume + used to create the Snapshot. +- Utilize the **block-storage snapshots list** command to retrieve a list of + all Snapshots and obtain the ID of the Snapshot for which you want to retrieve + details. +``` + +## Product catalog: +- Usage: +- ./mgc block-storage snapshots get [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --expand array(enum) Expand (default []) +- -h, --help help for get +- --id uuid Id (required) +- -v, --version version for get + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/block-storage/snapshots/help.md b/docs/block-storage/snapshots/help.md new file mode 100644 index 0000000..2964bfc --- /dev/null +++ b/docs/block-storage/snapshots/help.md @@ -0,0 +1,29 @@ +# Operations with snapshots for volumes. + +## Usage: +```bash +Usage: + ./mgc block-storage snapshots [flags] + ./mgc block-storage snapshots [command] +``` + +## Product catalog: +- Commands: +- create Create a snapshot +- delete Delete a snapshot +- get Retrieve the details of a snapshot +- list List snapshots in the current tenant +- rename Rename a snapshot +- restore Restore a snapshot to a new volume + +## Other commands: +- Flags: +- -h, --help help for snapshots +- -v, --version version for snapshots + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/block-storage/snapshots/list/help.md b/docs/block-storage/snapshots/list/help.md new file mode 100644 index 0000000..1cd18c9 --- /dev/null +++ b/docs/block-storage/snapshots/list/help.md @@ -0,0 +1,31 @@ +# Retrieve a list of Snapshots for the currently authenticated tenant. + +## Usage: +```bash +#### Notes +- Use the expand argument to obtain additional details about the Volume used to + create each Snapshot. +``` + +## Product catalog: +- Usage: +- ./mgc block-storage snapshots list [flags] + +## Other commands: +- Flags: +- --control.limit integer Limit (default 50) +- --control.offset integer Offset +- --control.sort string Sort (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- --expand array(enum) Expand (default []) +- -h, --help help for list +- -v, --version version for list + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/block-storage/snapshots/rename/help.md b/docs/block-storage/snapshots/rename/help.md new file mode 100644 index 0000000..b095751 --- /dev/null +++ b/docs/block-storage/snapshots/rename/help.md @@ -0,0 +1,28 @@ +# Rename a Snapshot for the currently authenticated tenant. + +## Usage: +```bash +#### Rules +- The Snapshot name must be unique; otherwise, renaming will not be allowed. +``` + +## Product catalog: +- #### Notes +- - Utilize the **block-storage snapshots list** command to retrieve a list of +- all Snapshots and obtain the ID of the Snapshot you wish to rename. + +## Other commands: +- Usage: +- ./mgc block-storage snapshots rename [id] [flags] + +## Flags: +```bash +Flags: + --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") + --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' + -h, --help help for rename + --id uuid Id (required) + --name string Name (between 1 and 255 characters) (required) + -v, --version version for rename +``` + diff --git a/docs/block-storage/snapshots/restore/help.md b/docs/block-storage/snapshots/restore/help.md new file mode 100644 index 0000000..dad80f7 --- /dev/null +++ b/docs/block-storage/snapshots/restore/help.md @@ -0,0 +1,31 @@ +# Restore a Snapshot on a new Volume to the currently + authenticated tenant. + +## Usage: +```bash +The restored Volume can be used when it reaches the "available" state and the + "completed" status. +``` + +## Product catalog: +- #### Notes +- - To obtain the ID of the Snapshot you wish to restore, you can use the +- **block-storage snapshots list** command to list all Snapshots. +- - Check the state and status of your Volume using the +- **block-storage volume get --id [uuid]** command. + +## Other commands: +- Usage: +- ./mgc block-storage snapshots restore [snapshot-id] [flags] + +## Flags: +```bash +Flags: + --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") + --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' + -h, --help help for restore + --name string Name (min character count: 1) (required) + --snapshot-id uuid Snapshot Id (required) + -v, --version version for restore +``` + diff --git a/docs/block-storage/volume-attachment/create/help.md b/docs/block-storage/volume-attachment/create/help.md new file mode 100644 index 0000000..afe3053 --- /dev/null +++ b/docs/block-storage/volume-attachment/create/help.md @@ -0,0 +1,28 @@ +# Attach a volume to a virtual machine instance + +## Usage: +```bash +Usage: + ./mgc block-storage volume-attachment create [flags] +``` + +## Product catalog: +- Flags: +- --block-storage-id uuid Id +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for create +- --virtual-machine-id uuid Virtual Machine Id + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/block-storage/volume-attachment/delete/help.md b/docs/block-storage/volume-attachment/delete/help.md new file mode 100644 index 0000000..211a4c4 --- /dev/null +++ b/docs/block-storage/volume-attachment/delete/help.md @@ -0,0 +1,26 @@ +# Detach a volume from a virtual machine instance + +## Usage: +```bash +Usage: + ./mgc block-storage volume-attachment delete [flags] +``` + +## Product catalog: +- Flags: +- --block-storage-id uuid Id +- -h, --help help for delete +- --virtual-machine-id uuid Virtual Machine Id + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/block-storage/volume-attachment/get/help.md b/docs/block-storage/volume-attachment/get/help.md new file mode 100644 index 0000000..538e765 --- /dev/null +++ b/docs/block-storage/volume-attachment/get/help.md @@ -0,0 +1,26 @@ +# Check if a volume is attached to a virtual machine instance + +## Usage: +```bash +Usage: + ./mgc block-storage volume-attachment get [flags] +``` + +## Product catalog: +- Flags: +- --block-storage-id uuid Id +- -h, --help help for get +- --virtual-machine-id uuid Virtual Machine Id + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/block-storage/volume-attachment/help.md b/docs/block-storage/volume-attachment/help.md new file mode 100644 index 0000000..8e70fe1 --- /dev/null +++ b/docs/block-storage/volume-attachment/help.md @@ -0,0 +1,25 @@ +# Block Storage Volume Attachment + +## Usage: +```bash +Usage: + ./mgc block-storage volume-attachment [flags] + ./mgc block-storage volume-attachment [command] +``` + +## Product catalog: +- Commands: +- create Attach a volume to a virtual machine instance +- delete Detach a volume from a virtual machine instance +- get Check if a volume is attached to a virtual machine instance + +## Other commands: +- Flags: +- -h, --help help for volume-attachment + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/block-storage/volume-types/help.md b/docs/block-storage/volume-types/help.md new file mode 100644 index 0000000..bacc9eb --- /dev/null +++ b/docs/block-storage/volume-types/help.md @@ -0,0 +1,24 @@ +# Operations with volume types for volumes. + +## Usage: +```bash +Usage: + ./mgc block-storage volume-types [flags] + ./mgc block-storage volume-types [command] +``` + +## Product catalog: +- Commands: +- list List volume types + +## Other commands: +- Flags: +- -h, --help help for volume-types +- -v, --version version for volume-types + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/block-storage/volume-types/list/help.md b/docs/block-storage/volume-types/list/help.md new file mode 100644 index 0000000..56bb875 --- /dev/null +++ b/docs/block-storage/volume-types/list/help.md @@ -0,0 +1,22 @@ +# List Volume Types allowed in the current region. + +## Usage: +```bash +#### Notes +``` + +## Product catalog: +- - Volume types are managed internally. If you wish to use a Volume Type that +- is not yet available, please contact our support team for assistance. + +## Other commands: +- Usage: +- ./mgc block-storage volume-types list [flags] + +## Flags: +```bash +Flags: + -h, --help help for list + -v, --version version for list +``` + diff --git a/docs/block-storage/volumes/attach/help.md b/docs/block-storage/volumes/attach/help.md new file mode 100644 index 0000000..c4616c7 --- /dev/null +++ b/docs/block-storage/volumes/attach/help.md @@ -0,0 +1,29 @@ +# Attach a Volume to a Virtual Machine instance for the currently + authenticated tenant. + +## Usage: +```bash +The Volume attachment will be completed when the Volume status returns to +"completed", and the state becomes "in-use". +``` + +## Product catalog: +- #### Rules +- - The Volume and the Virtual Machine must belong to the same tenant. +- - Both the Volume and Virtual Machine must have the status "completed". +- - The Volume's state must be "available". +- - The Virtual Machine's state must be "stopped" or "running". + +## Other commands: +- #### Notes +- - Verify the state and status of your Volume using the +- **block-storage volume get --id [uuid]** command. +- - Verify the state and status of your Virtual Machine using the +- **virtual-machine instances get --id [uuid]** command". + +## Flags: +```bash +Usage: + ./mgc block-storage volumes attach [id] [virtual-machine-id] [flags] +``` + diff --git a/docs/block-storage/volumes/create/help.md b/docs/block-storage/volumes/create/help.md new file mode 100644 index 0000000..aec439b --- /dev/null +++ b/docs/block-storage/volumes/create/help.md @@ -0,0 +1,26 @@ +# Create a Volume for the currently authenticated tenant. + +## Usage: +```bash +The Volume can be used when it reaches the "available" state and "completed" + status. +``` + +## Product catalog: +- #### Rules +- - The Volume name must be unique; otherwise, the creation will be disallowed. +- - The Volume type must be available to use. + +## Other commands: +- #### Notes +- - Utilize the **block-storage volume-types list** command to retrieve a list +- of all available Volume Types. +- - Verify the state and status of your Volume using the +- **block-storage volume get --id [uuid]** command". + +## Flags: +```bash +Usage: + ./mgc block-storage volumes create [flags] +``` + diff --git a/docs/block-storage/volumes/delete/help.md b/docs/block-storage/volumes/delete/help.md new file mode 100644 index 0000000..d619e04 --- /dev/null +++ b/docs/block-storage/volumes/delete/help.md @@ -0,0 +1,31 @@ +# Delete a Volume for the currently authenticated tenant. + +## Usage: +```bash +#### Rules +- The Volume cannot be attached to a Virtual Machine, i.e., its state cannot + be "in-use". If necessary, detach the Volume from the Virtual Machine before + proceeding with deletion. +- The Volume must not have any snapshots. If necessary, delete the Volume's + snapshots before proceeding with deletion. +- The Volume must have the status "completed", i.e., must not have any + actions in progress. +``` + +## Product catalog: +- #### Notes +- - Check the state and status of your Volume using the +- **block-storage volume get --id [uuid]** command". + +## Other commands: +- Usage: +- ./mgc block-storage volumes delete [id] [flags] + +## Flags: +```bash +Flags: + -h, --help help for delete + --id uuid Id (required) + -v, --version version for delete +``` + diff --git a/docs/block-storage/volumes/detach/help.md b/docs/block-storage/volumes/detach/help.md new file mode 100644 index 0000000..4d62197 --- /dev/null +++ b/docs/block-storage/volumes/detach/help.md @@ -0,0 +1,34 @@ +# Detach a Volume from a Virtual Machine instance for the + currently authenticated tenant. + +## Usage: +```bash +The Volume detachment will be completed when the Volume state returns to + "available," and the status becomes "completed". +``` + +## Product catalog: +- #### Rules +- - The Volume and the Virtual Machine must belong to the same tenant. +- - Both the Volume and Virtual Machine must have the status "completed". +- - The Volume's state must be "in-use". +- - The Virtual Machine's state must be "stopped". + +## Other commands: +- #### Notes +- - Verify the state and status of your Volume using the +- **block-storage volume get --id [uuid]** command. +- - Verify the state and status of your Virtual Machine using the +- **virtual-machine instances get --id [uuid]** command. +- - Ensure that any file systems on the device within your operating system are +- unmounted before detaching the Volume. + +## Flags: +```bash +#### Troubleshooting +- A failure during detachment can result in the Volume becoming stuck in the + busy state. If this occurs, detachment may be delayed indefinitely until you + unmount the Volume, force detachment, reboot the instance, or perform all + three. +``` + diff --git a/docs/block-storage/volumes/extend/help.md b/docs/block-storage/volumes/extend/help.md new file mode 100644 index 0000000..4a57c21 --- /dev/null +++ b/docs/block-storage/volumes/extend/help.md @@ -0,0 +1,28 @@ +# Extend the size of an existing Volume for the currently + authenticated tenant. + +## Usage: +```bash +The Volume extension will be completed when the Volume status returns to + "completed". +``` + +## Product catalog: +- #### Rules +- - The Volume state must be "available". +- - The Volume status must be "completed" or "extend_error". +- - The new Volume size must be larger than the current size. + +## Other commands: +- #### Notes +- - Utilize the block-storage volume list command to retrieve a list of all +- Volumes and obtain the ID of the Volume you want to extend. +- - Storage quotas are managed internally. If the operation fails due to quota +- restrictions, please contact our support team for assistance. + +## Flags: +```bash +Usage: + ./mgc block-storage volumes extend [id] [flags] +``` + diff --git a/docs/block-storage/volumes/get/help.md b/docs/block-storage/volumes/get/help.md new file mode 100644 index 0000000..43f0a6f --- /dev/null +++ b/docs/block-storage/volumes/get/help.md @@ -0,0 +1,33 @@ +# Retrieve details of a Volume for the currently authenticated tenant. + +## Usage: +```bash +#### Notes +- Use the **expand** argument to obtain additional details about the Volume + Type. +- Utilize the **block-storage volume list** command to retrieve a list of all + Volumes and obtain the ID of the Volume for which you want to retrieve + details. +``` + +## Product catalog: +- Usage: +- ./mgc block-storage volumes get [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --expand array(string) Expand: You can get more detailed info about: ['volume_type', 'attachment'] (default []) +- -h, --help help for get +- --id uuid Id (required) +- -v, --version version for get + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/block-storage/volumes/help.md b/docs/block-storage/volumes/help.md new file mode 100644 index 0000000..4370321 --- /dev/null +++ b/docs/block-storage/volumes/help.md @@ -0,0 +1,32 @@ +# Operations with volumes, including create, delete, extend, retype, list and other actions. + +## Usage: +```bash +Usage: + ./mgc block-storage volumes [flags] + ./mgc block-storage volumes [command] +``` + +## Product catalog: +- Commands: +- attach Attach a Volume +- create Create a new Volume +- delete Delete a Volume +- detach Detach a Volume +- extend Extend a Volume +- get Retrieve the details of a volume +- list List all Volumes +- rename Rename a volume +- retype Retype a Volume + +## Other commands: +- Flags: +- -h, --help help for volumes +- -v, --version version for volumes + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/block-storage/volumes/list/help.md b/docs/block-storage/volumes/list/help.md new file mode 100644 index 0000000..eabdc19 --- /dev/null +++ b/docs/block-storage/volumes/list/help.md @@ -0,0 +1,30 @@ +# Retrieve a list of Volumes for the currently authenticated tenant. + +## Usage: +```bash +#### Notes +- Use the expand argument to obtain additional details about the Volume Type. +``` + +## Product catalog: +- Usage: +- ./mgc block-storage volumes list [flags] + +## Other commands: +- Flags: +- --control.limit integer Limit (default 50) +- --control.offset integer Offset +- --control.sort string Sort (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- --expand array(string) Expand: You can get more detailed info about: ['volume_type', 'attachment'] (default []) +- -h, --help help for list +- -v, --version version for list + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/block-storage/volumes/rename/help.md b/docs/block-storage/volumes/rename/help.md new file mode 100644 index 0000000..ac615fe --- /dev/null +++ b/docs/block-storage/volumes/rename/help.md @@ -0,0 +1,28 @@ +# Rename a Volume for the currently authenticated tenant. + +## Usage: +```bash +#### Rules +- The Volume name must be unique; otherwise, renaming will not be allowed. +``` + +## Product catalog: +- #### Notes +- - Utilize the **block-storage volume list** command to retrieve a list of all +- Volumes and obtain the ID of the Volume you wish to rename. + +## Other commands: +- Usage: +- ./mgc block-storage volumes rename [id] [flags] + +## Flags: +```bash +Flags: + --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") + --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' + -h, --help help for rename + --id uuid Id (required) + --name string Name (between 1 and 255 characters) (required) + -v, --version version for rename +``` + diff --git a/docs/block-storage/volumes/retype/help.md b/docs/block-storage/volumes/retype/help.md new file mode 100644 index 0000000..1682c29 --- /dev/null +++ b/docs/block-storage/volumes/retype/help.md @@ -0,0 +1,28 @@ +# Change the Volume Type of an existing Volume for the currently + authenticated tenant. + +## Usage: +```bash +The Volume retype will be completed when the Volume status returns to + "completed". +``` + +## Product catalog: +- #### Rules +- - The Volume state must be "available". +- - The Volume status must be "completed" or "retype_error". +- - The new Volume Type must belong to the same region as the Volume. + +## Other commands: +- #### Notes +- - Utilize the **block-storage volume list** command to retrieve a list of all +- Volumes and obtain the ID of the Volume you want to retype. +- - Utilize the **block-storage volume-types list** command to retrieve a list of +- all Volume Types and obtain the ID of the Volume Type you want to use. + +## Flags: +```bash +Usage: + ./mgc block-storage volumes retype [id] [flags] +``` + diff --git a/docs/config/delete/help.md b/docs/config/delete/help.md new file mode 100644 index 0000000..70fd29e --- /dev/null +++ b/docs/config/delete/help.md @@ -0,0 +1,23 @@ +# Delete/unset a Config value that had been previously set. This does not +affect the environment variables + +## Usage: +```bash +Usage: + ./mgc config delete [key] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --key string Name of the config to be deleted (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/config/get-schema/help.md b/docs/config/get-schema/help.md new file mode 100644 index 0000000..3d59d9f --- /dev/null +++ b/docs/config/get-schema/help.md @@ -0,0 +1,23 @@ +# Get the JSON Schema for the specified Config. The Schema has +information about the accepted values for the Config, constraints, type, description, etc. + +## Usage: +```bash +Usage: + ./mgc config get-schema [key] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get-schema +- --key string (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/config/get/help.md b/docs/config/get/help.md new file mode 100644 index 0000000..6f3c910 --- /dev/null +++ b/docs/config/get/help.md @@ -0,0 +1,24 @@ +# Get a specific Config value that has been previously set. If there's an env variable +matching the key (in uppercase and with the 'MGC_' prefix), it'll be retreived. +Otherwise, the value will be searched for in the YAML file + +## Usage: +```bash +Usage: + ./mgc config get [key] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get +- --key string Name of the desired config (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/config/help.md b/docs/config/help.md new file mode 100644 index 0000000..c7d5e46 --- /dev/null +++ b/docs/config/help.md @@ -0,0 +1,30 @@ +# Configuration values are available to be set so that they persist between +different executions of the MgcSDK. They reside in a YAML file when set. +Config values may also be loaded via Environment Variables. Any Config available +(see 'list') may be exported as an env variable in uppercase with the 'MGC_' prefix + +## Usage: +```bash +Usage: + ./mgc config [flags] + ./mgc config [command] +``` + +## Product catalog: +- Aliases: +- config, conf + +## Other commands: +- Commands: +- delete Delete/unset a Config value that had been previously set +- get Get a specific Config value that has been previously set +- get-schema Get the JSON Schema for the specified Config +- list List all available Configs +- set Set a specific Config value in the configuration file + +## Flags: +```bash +Flags: + -h, --help help for config +``` + diff --git a/docs/config/list/help.md b/docs/config/list/help.md new file mode 100644 index 0000000..c109f60 --- /dev/null +++ b/docs/config/list/help.md @@ -0,0 +1,21 @@ +# List all available Configs + +## Usage: +```bash +Usage: + ./mgc config list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/config/set/help.md b/docs/config/set/help.md new file mode 100644 index 0000000..1ca0b61 --- /dev/null +++ b/docs/config/set/help.md @@ -0,0 +1,24 @@ +# Set a specific Config value in the configuration file + +## Usage: +```bash +Usage: + ./mgc config set [key] [value] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for set +- --key string Name of the desired config (required) +- --value anyValue New flag value +- Use --value=help for more details (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/credentials/help.md b/docs/container-registry/credentials/help.md new file mode 100644 index 0000000..f058c76 --- /dev/null +++ b/docs/container-registry/credentials/help.md @@ -0,0 +1,24 @@ +# Routes related to credentials to login to Docker. + +## Usage: +```bash +Usage: + ./mgc container-registry credentials [flags] + ./mgc container-registry credentials [command] +``` + +## Product catalog: +- Commands: +- list Get credentials for container registry + +## Other commands: +- Flags: +- -h, --help help for credentials +- -v, --version version for credentials + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/container-registry/credentials/list/help.md b/docs/container-registry/credentials/list/help.md new file mode 100644 index 0000000..d191941 --- /dev/null +++ b/docs/container-registry/credentials/list/help.md @@ -0,0 +1,25 @@ +# Return container registry user's authentication credentials. + +## Usage: +```bash +Usage: + ./mgc container-registry credentials list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/help.md b/docs/container-registry/help.md new file mode 100644 index 0000000..436c8b5 --- /dev/null +++ b/docs/container-registry/help.md @@ -0,0 +1,27 @@ +# Magalu Container Registry product API. + +## Usage: +```bash +Usage: + ./mgc container-registry [flags] + ./mgc container-registry [command] +``` + +## Product catalog: +- Commands: +- credentials Routes related to credentials to login to Docker. +- images Routes related to listing and deletion of images. +- registries Routes related to creation, listing and deletion of registries. +- repositories Routes related to listing and deletion of repositories. + +## Other commands: +- Flags: +- -h, --help help for container-registry +- -v, --version version for container-registry + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/container-registry/images/delete/help.md b/docs/container-registry/images/delete/help.md new file mode 100644 index 0000000..3cfcb23 --- /dev/null +++ b/docs/container-registry/images/delete/help.md @@ -0,0 +1,28 @@ +# Delete repository image by digest or tag + +## Usage: +```bash +Usage: + ./mgc container-registry images delete [registry-id] [repository-name] [digest-or-tag] [flags] +``` + +## Product catalog: +- Flags: +- --digest-or-tag string Digest or tag of an image (required) +- -h, --help help for delete +- --registry-id uuid Container Registry's UUID. (required) +- --repository-name string Repository's name. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/images/get/help.md b/docs/container-registry/images/get/help.md new file mode 100644 index 0000000..49720d8 --- /dev/null +++ b/docs/container-registry/images/get/help.md @@ -0,0 +1,29 @@ +# Show detailed information about the image. + +## Usage: +```bash +Usage: + ./mgc container-registry images get [registry-id] [repository-name] [digest-or-tag] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --digest-or-tag string Digest or tag of an image. (required) +- -h, --help help for get +- --registry-id uuid Container Registry's UUID. (required) +- --repository-name string Repository's name. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/images/help.md b/docs/container-registry/images/help.md new file mode 100644 index 0000000..52a32db --- /dev/null +++ b/docs/container-registry/images/help.md @@ -0,0 +1,26 @@ +# Routes related to listing and deletion of images. + +## Usage: +```bash +Usage: + ./mgc container-registry images [flags] + ./mgc container-registry images [command] +``` + +## Product catalog: +- Commands: +- delete Delete image by digest or tag +- get Get image details +- list List images in container registry repository + +## Other commands: +- Flags: +- -h, --help help for images +- -v, --version version for images + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/container-registry/images/list/help.md b/docs/container-registry/images/list/help.md new file mode 100644 index 0000000..9616349 --- /dev/null +++ b/docs/container-registry/images/list/help.md @@ -0,0 +1,31 @@ +# List all images in container registry repository + +## Usage: +```bash +Usage: + ./mgc container-registry images list [registry-id] [repository-name] [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit (min: 1) +- --control.offset integer Offset (min: 0) +- --control.sort string Fields to use as reference to sort. (pattern: (^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "pushed_at:desc") +- --expand array(string) You can get more detailed info about: ['tags_details', 'extra_attr', 'manifest_media_type', 'media_type'] +- -h, --help help for list +- --registry-id uuid Container Registry's UUID. (required) +- --repository-name string Repository's name. (required) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/registries/create/help.md b/docs/container-registry/registries/create/help.md new file mode 100644 index 0000000..9e4e765 --- /dev/null +++ b/docs/container-registry/registries/create/help.md @@ -0,0 +1,28 @@ +# Creates a container registry in Magalu Cloud. + +## Usage: +```bash +Usage: + ./mgc container-registry registries create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for create +- --name string A unique, global name for the container registry. It must be written in lowercase letters and consists only of numbers and letters, up to a limit of 63 characters. (required) +- -v, --version version for create + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/registries/delete/help.md b/docs/container-registry/registries/delete/help.md new file mode 100644 index 0000000..4e77f00 --- /dev/null +++ b/docs/container-registry/registries/delete/help.md @@ -0,0 +1,26 @@ +# Delete a container registry by uuid. + +## Usage: +```bash +Usage: + ./mgc container-registry registries delete [registry-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --registry-id uuid Container Registry's UUID. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/registries/get/help.md b/docs/container-registry/registries/get/help.md new file mode 100644 index 0000000..da9c140 --- /dev/null +++ b/docs/container-registry/registries/get/help.md @@ -0,0 +1,27 @@ +# Show detailed information about the user's container registry. + +## Usage: +```bash +Usage: + ./mgc container-registry registries get [registry-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --registry-id uuid Container Registry's UUID. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/registries/help.md b/docs/container-registry/registries/help.md new file mode 100644 index 0000000..a5921f6 --- /dev/null +++ b/docs/container-registry/registries/help.md @@ -0,0 +1,27 @@ +# Routes related to creation, listing and deletion of registries. + +## Usage: +```bash +Usage: + ./mgc container-registry registries [flags] + ./mgc container-registry registries [command] +``` + +## Product catalog: +- Commands: +- create Create a container registry +- delete Delete a container registry by registry_id +- get Get registry information +- list List all container registries + +## Other commands: +- Flags: +- -h, --help help for registries +- -v, --version version for registries + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/container-registry/registries/list/help.md b/docs/container-registry/registries/list/help.md new file mode 100644 index 0000000..936d014 --- /dev/null +++ b/docs/container-registry/registries/list/help.md @@ -0,0 +1,28 @@ +# List user's container registries. + +## Usage: +```bash +Usage: + ./mgc container-registry registries list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit (min: 1) +- --control.offset integer Offset (min: 0) +- --control.sort string Fields to use as reference to sort. (pattern: (^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/repositories/delete/help.md b/docs/container-registry/repositories/delete/help.md new file mode 100644 index 0000000..24a92a0 --- /dev/null +++ b/docs/container-registry/repositories/delete/help.md @@ -0,0 +1,27 @@ +# Delete a repository by name. + +## Usage: +```bash +Usage: + ./mgc container-registry repositories delete [registry-id] [repository-name] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --registry-id uuid Container Registry's UUID. (required) +- --repository-name string Repository's name. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/repositories/get/help.md b/docs/container-registry/repositories/get/help.md new file mode 100644 index 0000000..f7d7923 --- /dev/null +++ b/docs/container-registry/repositories/get/help.md @@ -0,0 +1,28 @@ +# Return detailed repository's information filtered by name. + +## Usage: +```bash +Usage: + ./mgc container-registry repositories get [registry-id] [repository-name] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --registry-id uuid Container Registry's UUID. (required) +- --repository-name string Repository's name. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/container-registry/repositories/help.md b/docs/container-registry/repositories/help.md new file mode 100644 index 0000000..786ea27 --- /dev/null +++ b/docs/container-registry/repositories/help.md @@ -0,0 +1,26 @@ +# Routes related to listing and deletion of repositories. + +## Usage: +```bash +Usage: + ./mgc container-registry repositories [flags] + ./mgc container-registry repositories [command] +``` + +## Product catalog: +- Commands: +- delete Delete a container registry repository by repository_name. +- get Get a container registry repository by repository_name +- list List all container registry repositories + +## Other commands: +- Flags: +- -h, --help help for repositories +- -v, --version version for repositories + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/container-registry/repositories/list/help.md b/docs/container-registry/repositories/list/help.md new file mode 100644 index 0000000..82d7791 --- /dev/null +++ b/docs/container-registry/repositories/list/help.md @@ -0,0 +1,29 @@ +# List all user's repositories in the container registry. + +## Usage: +```bash +Usage: + ./mgc container-registry repositories list [registry-id] [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit (min: 1) +- --control.offset integer Offset (min: 0) +- --control.sort string Fields to use as reference to sort. (pattern: (^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:desc") +- -h, --help help for list +- --registry-id uuid Container Registry's UUID. (required) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/backups/delete/help.md b/docs/dbaas/backups/delete/help.md new file mode 100644 index 0000000..99f0a87 --- /dev/null +++ b/docs/dbaas/backups/delete/help.md @@ -0,0 +1,26 @@ +# Deletes a database backup. + +## Usage: +```bash +Usage: + ./mgc dbaas backups delete [backup-id] [flags] +``` + +## Product catalog: +- Flags: +- --backup-id uuid Value referring to backup Id. (required) +- -h, --help help for delete +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/backups/get/help.md b/docs/dbaas/backups/get/help.md new file mode 100644 index 0000000..0cabca8 --- /dev/null +++ b/docs/dbaas/backups/get/help.md @@ -0,0 +1,27 @@ +# Get a backup detail. + +## Usage: +```bash +Usage: + ./mgc dbaas backups get [backup-id] [flags] +``` + +## Product catalog: +- Flags: +- --backup-id uuid Value referring to backup Id. (required) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/backups/help.md b/docs/dbaas/backups/help.md new file mode 100644 index 0000000..d888d29 --- /dev/null +++ b/docs/dbaas/backups/help.md @@ -0,0 +1,26 @@ +# Database backups management. + +## Usage: +```bash +Usage: + ./mgc dbaas backups [flags] + ./mgc dbaas backups [command] +``` + +## Product catalog: +- Commands: +- delete Delete Backup. +- get Backup Detail. +- list Backups List. + +## Other commands: +- Flags: +- -h, --help help for backups +- -v, --version version for backups + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/backups/list/help.md b/docs/dbaas/backups/list/help.md new file mode 100644 index 0000000..2471d8e --- /dev/null +++ b/docs/dbaas/backups/list/help.md @@ -0,0 +1,30 @@ +# List all backups. + +## Usage: +```bash +Usage: + ./mgc dbaas backups list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- -h, --help help for list +- --mode enum Value referring to backup mode. (one of "FULL" or "INCREMENTAL") +- --status enum Value referring to backup status. (one of "CREATED", "CREATING", "DELETED", "DELETING", "ERROR", "ERROR_DELETING" or "PENDING") +- --type enum Value referring to backup type. (one of "AUTOMATED" or "ON_DEMAND") +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/datastores/get/help.md b/docs/dbaas/datastores/get/help.md new file mode 100644 index 0000000..c7cdfcf --- /dev/null +++ b/docs/dbaas/datastores/get/help.md @@ -0,0 +1,26 @@ +# **Deprecated**: This endpoint is being phased out. Please use the `/v1/engines/{engine_id}` endpoint to retrieve the list of available engines instead. + +## Usage: +```bash +Returns a datastore detail. It is recommended to update your integration to use the newer `/v1/engines/{engine_id}` endpoint for improved functionality and future compatibility. +``` + +## Product catalog: +- Usage: +- ./mgc dbaas datastores get [engine-id] [flags] + +## Other commands: +- Flags: +- --engine-id uuid Datastore Id (Deprecated): Value referring to datastore Id. (required) +- -h, --help help for get +- -v, --version version for get + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/datastores/help.md b/docs/dbaas/datastores/help.md new file mode 100644 index 0000000..329af35 --- /dev/null +++ b/docs/dbaas/datastores/help.md @@ -0,0 +1,25 @@ +# Datastores available for database instances. + +## Usage: +```bash +Usage: + ./mgc dbaas datastores [flags] + ./mgc dbaas datastores [command] +``` + +## Product catalog: +- Commands: +- get Datastore detail (Deprecated). +- list List available datastores (Deprecated). + +## Other commands: +- Flags: +- -h, --help help for datastores +- -v, --version version for datastores + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/datastores/list/help.md b/docs/dbaas/datastores/list/help.md new file mode 100644 index 0000000..83317be --- /dev/null +++ b/docs/dbaas/datastores/list/help.md @@ -0,0 +1,28 @@ +# **Deprecated**: This endpoint is being phased out. Please use the `/v1/engines` endpoint to retrieve the list of available engines instead. + +## Usage: +```bash +Returns a list of available datastores. It is recommended to update your integration to use the newer `/v1/engines` endpoint for improved functionality and future compatibility. +``` + +## Product catalog: +- Usage: +- ./mgc dbaas datastores list [flags] + +## Other commands: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- -h, --help help for list +- --status enum Value referring to engine status. (one of "ACTIVE" or "DEPRECATED") +- -v, --version version for list + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/engines/get/help.md b/docs/dbaas/engines/get/help.md new file mode 100644 index 0000000..6aa26d6 --- /dev/null +++ b/docs/dbaas/engines/get/help.md @@ -0,0 +1,26 @@ +# Returns a engine detail. + +## Usage: +```bash +Usage: + ./mgc dbaas engines get [engine-id] [flags] +``` + +## Product catalog: +- Flags: +- --engine-id uuid Datastore Id (Deprecated): Value referring to datastore Id. (required) +- -h, --help help for get +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/engines/help.md b/docs/dbaas/engines/help.md new file mode 100644 index 0000000..65d872c --- /dev/null +++ b/docs/dbaas/engines/help.md @@ -0,0 +1,25 @@ +# Engines available for database instances. + +## Usage: +```bash +Usage: + ./mgc dbaas engines [flags] + ./mgc dbaas engines [command] +``` + +## Product catalog: +- Commands: +- get Engine detail. +- list List available engines. + +## Other commands: +- Flags: +- -h, --help help for engines +- -v, --version version for engines + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/engines/list/help.md b/docs/dbaas/engines/list/help.md new file mode 100644 index 0000000..21230f3 --- /dev/null +++ b/docs/dbaas/engines/list/help.md @@ -0,0 +1,28 @@ +# Returns a list of available engines. + +## Usage: +```bash +Usage: + ./mgc dbaas engines list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- -h, --help help for list +- --status enum Value referring to engine status. (one of "ACTIVE" or "DEPRECATED") +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/flavors/get/help.md b/docs/dbaas/flavors/get/help.md new file mode 100644 index 0000000..dbdb318 --- /dev/null +++ b/docs/dbaas/flavors/get/help.md @@ -0,0 +1,26 @@ +# Returns a flavor detail. + +## Usage: +```bash +Usage: + ./mgc dbaas flavors get [flavor-id] [flags] +``` + +## Product catalog: +- Flags: +- --flavor-id uuid Flavor Id: Flavor Unique Id. (required) +- -h, --help help for get +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/flavors/help.md b/docs/dbaas/flavors/help.md new file mode 100644 index 0000000..f778694 --- /dev/null +++ b/docs/dbaas/flavors/help.md @@ -0,0 +1,25 @@ +# Flavors available for database instances. + +## Usage: +```bash +Usage: + ./mgc dbaas flavors [flags] + ./mgc dbaas flavors [command] +``` + +## Product catalog: +- Commands: +- get Flavor detail. +- list List available flavors. + +## Other commands: +- Flags: +- -h, --help help for flavors +- -v, --version version for flavors + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/flavors/list/help.md b/docs/dbaas/flavors/list/help.md new file mode 100644 index 0000000..d6ac6f8 --- /dev/null +++ b/docs/dbaas/flavors/list/help.md @@ -0,0 +1,29 @@ +# Returns a list of available flavors. A flavor is a hardware template that defines the size of RAM and vCPU. + +## Usage: +```bash +Usage: + ./mgc dbaas flavors list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- --engine-id uuid Engine Id unique identifier +- -h, --help help for list +- --status enum An enumeration. (one of "ACTIVE" or "DEPRECATED") (default "ACTIVE") +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/help.md b/docs/dbaas/help.md new file mode 100644 index 0000000..6baf913 --- /dev/null +++ b/docs/dbaas/help.md @@ -0,0 +1,29 @@ +# DBaaS API Product. + +## Usage: +```bash +Usage: + ./mgc dbaas [flags] + ./mgc dbaas [command] +``` + +## Product catalog: +- Aliases: +- dbaas, database, db + +## Other commands: +- Commands: +- backups Database backups management. +- datastores Datastores available for database instances. +- engines Engines available for database instances. +- flavors Flavors available for database instances. +- instances Database instances management. +- replicas Database replicas management. + +## Flags: +```bash +Flags: + -h, --help help for dbaas + -v, --version version for dbaas +``` + diff --git a/docs/dbaas/instances/backups/create/help.md b/docs/dbaas/instances/backups/create/help.md new file mode 100644 index 0000000..9013ed9 --- /dev/null +++ b/docs/dbaas/instances/backups/create/help.md @@ -0,0 +1,29 @@ +# Creates a new backup asynchronously. + +## Usage: +```bash +Usage: + ./mgc dbaas instances backups create [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for create +- --instance-id uuid Value referring to instance Id. (required) +- --mode enum Backup Mode Request: An enumeration. (must be "FULL") (required) +- -v, --version version for create + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/backups/delete/help.md b/docs/dbaas/instances/backups/delete/help.md new file mode 100644 index 0000000..5c16f29 --- /dev/null +++ b/docs/dbaas/instances/backups/delete/help.md @@ -0,0 +1,27 @@ +# Deletes a database backup. + +## Usage: +```bash +Usage: + ./mgc dbaas instances backups delete [instance-id] [backup-id] [flags] +``` + +## Product catalog: +- Flags: +- --backup-id uuid Value referring to backup Id. (required) +- -h, --help help for delete +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/backups/get/help.md b/docs/dbaas/instances/backups/get/help.md new file mode 100644 index 0000000..7961bf5 --- /dev/null +++ b/docs/dbaas/instances/backups/get/help.md @@ -0,0 +1,28 @@ +# Get a backup detail. + +## Usage: +```bash +Usage: + ./mgc dbaas instances backups get [instance-id] [backup-id] [flags] +``` + +## Product catalog: +- Flags: +- --backup-id uuid Value referring to backup Id. (required) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/backups/help.md b/docs/dbaas/instances/backups/help.md new file mode 100644 index 0000000..f8ce7de --- /dev/null +++ b/docs/dbaas/instances/backups/help.md @@ -0,0 +1,27 @@ +# Database instances management. | backups + +## Usage: +```bash +Usage: + ./mgc dbaas instances backups [flags] + ./mgc dbaas instances backups [command] +``` + +## Product catalog: +- Commands: +- create Backup Create. +- delete Delete Backup. +- get Backup Detail. +- list Backups List. + +## Other commands: +- Flags: +- -h, --help help for backups +- -v, --version version for backups + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/instances/backups/list/help.md b/docs/dbaas/instances/backups/list/help.md new file mode 100644 index 0000000..f3c83da --- /dev/null +++ b/docs/dbaas/instances/backups/list/help.md @@ -0,0 +1,31 @@ +# List all backups. + +## Usage: +```bash +Usage: + ./mgc dbaas instances backups list [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- -h, --help help for list +- --instance-id uuid Value referring to instance Id. (required) +- --mode enum Value referring to backup mode. (one of "FULL" or "INCREMENTAL") +- --status enum Value referring to backup status. (one of "CREATED", "CREATING", "DELETED", "DELETING", "ERROR", "ERROR_DELETING" or "PENDING") +- --type enum Value referring to backup type. (one of "AUTOMATED" or "ON_DEMAND") +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/create/help.md b/docs/dbaas/instances/create/help.md new file mode 100644 index 0000000..de95d70 --- /dev/null +++ b/docs/dbaas/instances/create/help.md @@ -0,0 +1,43 @@ +# Creates a new database instance asynchronously for a tenant. + +## Usage: +```bash +Usage: + ./mgc dbaas instances create [flags] +``` + +## Product catalog: +- Examples: +- ./mgc dbaas instances create --volume.size=30 + +## Other commands: +- Flags: +- --backup-retention-days integer Backup Retention Days: The number of days that a particular backup is kept until its deletion. (default 7) +- --backup-start-at time Backup Start At: Start time (UTC timezone) which is allowed to start the automated backup process. (default "04:00:00") +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --datastore-id uuid Datastore Id (Deprecated): **Deprecated**: This property is being deprecated in favor of 'engine_id'. Please update your requests to use 'engine_id' for improved functionality and future compatibility. +- +- --engine-id uuid Engine Id +- --flavor-id uuid Flavor Id (required) +- -h, --help help for create +- --name string Name (max character count: 100) (required) +- --parameters array(object) Use --parameters=help for more details (default []) +- --password string Password (max character count: 50) (required) +- --user string User (max character count: 25) (required) +- -v, --version version for create +- --volume object Instance Volume Request (properties: size and type) +- Use --volume=help for more details (required) +- --volume.size integer Instance Volume Request: The size of the volume (in GiB). (range: 10 - 50000) +- This is the same as '--volume=size:integer'. +- --volume.type enum Instance Volume Request: The type of the volume. (one of "CLOUD_HDD", "CLOUD_NVME" or "CLOUD_NVME_15K") +- This is the same as '--volume=type:enum'. (default "CLOUD_NVME_15K") + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/instances/delete/help.md b/docs/dbaas/instances/delete/help.md new file mode 100644 index 0000000..fcc264d --- /dev/null +++ b/docs/dbaas/instances/delete/help.md @@ -0,0 +1,26 @@ +# Deletes a database instance. + +## Usage: +```bash +Usage: + ./mgc dbaas instances delete [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/get/help.md b/docs/dbaas/instances/get/help.md new file mode 100644 index 0000000..3f7e849 --- /dev/null +++ b/docs/dbaas/instances/get/help.md @@ -0,0 +1,28 @@ +# Returns a database instance detail. + +## Usage: +```bash +Usage: + ./mgc dbaas instances get [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --control.expand enum Instance extra attributes or relations to show with the main query. When available, more than one value can be informed using commas. e.g: '--control.expand="replicas"' (must be "replicas") +- -h, --help help for get +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/help.md b/docs/dbaas/instances/help.md new file mode 100644 index 0000000..97ac360 --- /dev/null +++ b/docs/dbaas/instances/help.md @@ -0,0 +1,33 @@ +# Database instances management. + +## Usage: +```bash +Usage: + ./mgc dbaas instances [flags] + ./mgc dbaas instances [command] +``` + +## Product catalog: +- Commands: +- backups backups +- create Creates a new database instance. +- delete Deletes a database instance. +- get Database instance details. +- list List all database instances. +- resize Resizes a database instance. +- restores Backup restore. +- start Starts a database instance. +- stop Stops a database instance. +- update Database instance update. + +## Other commands: +- Flags: +- -h, --help help for instances +- -v, --version version for instances + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/instances/list/help.md b/docs/dbaas/instances/list/help.md new file mode 100644 index 0000000..d3de4c1 --- /dev/null +++ b/docs/dbaas/instances/list/help.md @@ -0,0 +1,36 @@ +# Returns a list of database instances for a x-tenant-id. + +## Usage: +```bash +Usage: + ./mgc dbaas instances list [flags] +``` + +## Product catalog: +- Examples: +- ./mgc dbaas instances list --status="ACTIVE" + +## Other commands: +- Flags: +- --control.expand enum Instance extra attributes or relations to show with the main query. When available, more than one value can be informed using commas. e.g: '--control.expand="replicas"' (must be "replicas") +- --control.limit integer The maximum number of items per page. (range: 1 - 25) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- --engine-id uuid Engine Id unique identifier +- -h, --help help for list +- --status enum Value referring to instance status. (one of "ACTIVE", "BACKING_UP", "CREATING", "DELETED", "DELETING", "ERROR", "ERROR_DELETING", "MAINTENANCE", "PENDING", "REBOOT", "RESIZING", "RESTORING", "STARTING", "STOPPED" or "STOPPING") +- -v, --version version for list +- --volume.size integer Volume Size exact size +- --volume.size-gt integer Volume Size greater than +- --volume.size-gte integer Volume Size greater than or equal +- --volume.size-lt integer Volume Size less than +- --volume.size-lte integer Volume Size less than or equal + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/instances/resize/help.md b/docs/dbaas/instances/resize/help.md new file mode 100644 index 0000000..4401ab4 --- /dev/null +++ b/docs/dbaas/instances/resize/help.md @@ -0,0 +1,35 @@ +# Resizes a database instance. + +## Usage: +```bash +Usage: + ./mgc dbaas instances resize [instance-id] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc dbaas instances resize --volume.size=30 + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --flavor-id uuid Flavor Id +- -h, --help help for resize +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for resize +- --volume object Instance Volume Request (properties: size and type) +- Use --volume=help for more details +- --volume.size integer Instance Volume Request: The size of the volume (in GiB). (range: 10 - 50000) +- This is the same as '--volume=size:integer'. +- --volume.type enum Instance Volume Request: The type of the volume. (one of "CLOUD_HDD", "CLOUD_NVME" or "CLOUD_NVME_15K") +- This is the same as '--volume=type:enum'. (default "CLOUD_NVME_15K") + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/instances/restores/help.md b/docs/dbaas/instances/restores/help.md new file mode 100644 index 0000000..e29d6e3 --- /dev/null +++ b/docs/dbaas/instances/restores/help.md @@ -0,0 +1,28 @@ +# Restores a backup for an instance asynchronously. + +## Usage: +```bash +Usage: + ./mgc dbaas instances restores [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --backup-id uuid Backup Id (required) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for restores +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for restores + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/start/help.md b/docs/dbaas/instances/start/help.md new file mode 100644 index 0000000..93b425f --- /dev/null +++ b/docs/dbaas/instances/start/help.md @@ -0,0 +1,27 @@ +# Starts a database instance. + +## Usage: +```bash +Usage: + ./mgc dbaas instances start [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for start +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for start + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/stop/help.md b/docs/dbaas/instances/stop/help.md new file mode 100644 index 0000000..f17f44f --- /dev/null +++ b/docs/dbaas/instances/stop/help.md @@ -0,0 +1,27 @@ +# Stops a database instance. + +## Usage: +```bash +Usage: + ./mgc dbaas instances stop [instance-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for stop +- --instance-id uuid Value referring to instance Id. (required) +- -v, --version version for stop + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/instances/update/help.md b/docs/dbaas/instances/update/help.md new file mode 100644 index 0000000..131a0c2 --- /dev/null +++ b/docs/dbaas/instances/update/help.md @@ -0,0 +1,31 @@ +# Updates a database instance. + +## Usage: +```bash +Usage: + ./mgc dbaas instances update [instance-id] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc dbaas instances update --backup-retention-days=7 --backup-start-at="04:00:00" --status="ACTIVE" + +## Other commands: +- Flags: +- --backup-retention-days integer Backup Retention Days: The number of days that a particular backup is kept until its deletion. +- --backup-start-at time Backup Start At: Start time (UTC timezone) which is allowed to start the automated backup process. +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for update +- --instance-id uuid Value referring to instance Id. (required) +- --status enum Instance Status Update (one of "ACTIVE" or "STOPPED") +- -v, --version version for update + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/dbaas/replicas/create/help.md b/docs/dbaas/replicas/create/help.md new file mode 100644 index 0000000..078360f --- /dev/null +++ b/docs/dbaas/replicas/create/help.md @@ -0,0 +1,29 @@ +# Creates a new replica for an instance asynchronously. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --flavor-id uuid Flavor Id +- -h, --help help for create +- --name string Name (max character count: 255) (required) +- --source-id uuid Source Id (required) +- -v, --version version for create + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/delete/help.md b/docs/dbaas/replicas/delete/help.md new file mode 100644 index 0000000..85a74a7 --- /dev/null +++ b/docs/dbaas/replicas/delete/help.md @@ -0,0 +1,26 @@ +# Deletes a replica instance. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas delete [replica-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --replica-id uuid Database Replica Id: Database Replica Unique Id (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/get/help.md b/docs/dbaas/replicas/get/help.md new file mode 100644 index 0000000..7cbfc9a --- /dev/null +++ b/docs/dbaas/replicas/get/help.md @@ -0,0 +1,27 @@ +# Get an instance replica detail. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas get [replica-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --replica-id uuid Value referring to replica Id. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/help.md b/docs/dbaas/replicas/help.md new file mode 100644 index 0000000..a4ebc7f --- /dev/null +++ b/docs/dbaas/replicas/help.md @@ -0,0 +1,30 @@ +# Database replicas management. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas [flags] + ./mgc dbaas replicas [command] +``` + +## Product catalog: +- Commands: +- create Replica Create. +- delete Deletes a replica instance. +- get Replica Detail. +- list Replicas List. +- resize Replica Resize. +- start Replica Start. +- stop Replica Stop. + +## Other commands: +- Flags: +- -h, --help help for replicas +- -v, --version version for replicas + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/dbaas/replicas/list/help.md b/docs/dbaas/replicas/list/help.md new file mode 100644 index 0000000..fe5af89 --- /dev/null +++ b/docs/dbaas/replicas/list/help.md @@ -0,0 +1,28 @@ +# List all replicas for a given instance. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer The maximum number of items per page. (range: 1 - 50) (default 10) +- --control.offset integer The number of items to skip before starting to collect the result set. (min: 0) +- -h, --help help for list +- --source-id uuid Value referring to source Id. +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/resize/help.md b/docs/dbaas/replicas/resize/help.md new file mode 100644 index 0000000..3537e1f --- /dev/null +++ b/docs/dbaas/replicas/resize/help.md @@ -0,0 +1,29 @@ +# Resize an instance replica. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas resize [replica-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- --flavor-id uuid Flavor Id (required) +- -h, --help help for resize +- --replica-id uuid Value referring to replica Id. (required) +- -v, --version version for resize + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/start/help.md b/docs/dbaas/replicas/start/help.md new file mode 100644 index 0000000..3604c70 --- /dev/null +++ b/docs/dbaas/replicas/start/help.md @@ -0,0 +1,27 @@ +# Start an instance replica. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas start [replica-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for start +- --replica-id uuid Value referring to replica Id. (required) +- -v, --version version for start + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/dbaas/replicas/stop/help.md b/docs/dbaas/replicas/stop/help.md new file mode 100644 index 0000000..bf0e8cf --- /dev/null +++ b/docs/dbaas/replicas/stop/help.md @@ -0,0 +1,27 @@ +# Stop an instance replica. + +## Usage: +```bash +Usage: + ./mgc dbaas replicas stop [replica-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for stop +- --replica-id uuid Value referring to replica Id. (required) +- -v, --version version for stop + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/help.md b/docs/help.md new file mode 100644 index 0000000..d7c95d2 --- /dev/null +++ b/docs/help.md @@ -0,0 +1,37 @@ +# This CLI is a dynamic processor of OpenAPI files that +can generate a command line on-demand for Rest manipulation + +## Usage: +```bash +Usage: + ./mgc [flags] + ./mgc [command] +``` + +## Product catalog: +- Product catalog: +- auth Actions with ID Magalu to log in, refresh tokens, change tenants and others +- block-storage Block Storage API Product Documentation +- config Manage Configuration values +- container-registry Magalu Container Registry product API. +- dbaas DBaaS API Product. +- kubernetes APIs related to the Kubernetes product. +- network APIs referentes ao produto de VPC +- object-storage Operations for Object Storage API +- profile Profile related commands +- virtual-machine Virtual Machine Api Product + +## Other commands: +- Other commands: +- completion Generate the autocompletion script for the specified shell +- dump-tree Print command tree +- help Help about any command + +## Flags: +```bash +Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + -h, --help help for ./mgc + -v, --version version for ./mgc +``` + diff --git a/docs/http/do/help.md b/docs/http/do/help.md new file mode 100644 index 0000000..97e55a7 --- /dev/null +++ b/docs/http/do/help.md @@ -0,0 +1,28 @@ +# Execute generic http request + +## Usage: +```bash +Usage: + ./mgc http do [flags] +``` + +## Product catalog: +- Flags: +- --body string +- --headers object Use --headers=help for more details +- -h, --help help for do +- --method enum (one of "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT" or "TRACE") (required) +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/help.md b/docs/http/help.md new file mode 100644 index 0000000..dd2a969 --- /dev/null +++ b/docs/http/help.md @@ -0,0 +1,24 @@ +# HTTP access + +## Usage: +```bash +Usage: + ./mgc http [flags] + ./mgc http [command] +``` + +## Product catalog: +- Commands: +- do Execute generic http request +- json JSON HTTP access + +## Other commands: +- Flags: +- -h, --help help for http + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/http/json/delete/help.md b/docs/http/json/delete/help.md new file mode 100644 index 0000000..1111c6c --- /dev/null +++ b/docs/http/json/delete/help.md @@ -0,0 +1,26 @@ +# Call using HTTP DELETE + +## Usage: +```bash +Usage: + ./mgc http json delete [flags] +``` + +## Product catalog: +- Flags: +- --headers object Use --headers=help for more details +- -h, --help help for delete +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/get/help.md b/docs/http/json/get/help.md new file mode 100644 index 0000000..85c1ac3 --- /dev/null +++ b/docs/http/json/get/help.md @@ -0,0 +1,26 @@ +# Call using HTTP GET + +## Usage: +```bash +Usage: + ./mgc http json get [flags] +``` + +## Product catalog: +- Flags: +- --headers object Use --headers=help for more details +- -h, --help help for get +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/head/help.md b/docs/http/json/head/help.md new file mode 100644 index 0000000..eddf435 --- /dev/null +++ b/docs/http/json/head/help.md @@ -0,0 +1,26 @@ +# Call using HTTP HEAD + +## Usage: +```bash +Usage: + ./mgc http json head [flags] +``` + +## Product catalog: +- Flags: +- --headers object Use --headers=help for more details +- -h, --help help for head +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/help.md b/docs/http/json/help.md new file mode 100644 index 0000000..cc4cf9e --- /dev/null +++ b/docs/http/json/help.md @@ -0,0 +1,30 @@ +# JSON HTTP access + +## Usage: +```bash +Usage: + ./mgc http json [flags] + ./mgc http json [command] +``` + +## Product catalog: +- Commands: +- delete Call using HTTP DELETE +- get Call using HTTP GET +- head Call using HTTP HEAD +- options Call using HTTP OPTIONS +- patch Call using HTTP PATCH +- post Call using HTTP POST +- put Call using HTTP PUT +- trace Call using HTTP TRACE + +## Other commands: +- Flags: +- -h, --help help for json + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/http/json/options/help.md b/docs/http/json/options/help.md new file mode 100644 index 0000000..3132a81 --- /dev/null +++ b/docs/http/json/options/help.md @@ -0,0 +1,28 @@ +# Call using HTTP OPTIONS + +## Usage: +```bash +Usage: + ./mgc http json options [flags] +``` + +## Product catalog: +- Flags: +- --body anyOf (at least one of: boolean, string, number, integer, array or object) +- Use --body=help for more details +- --headers object Use --headers=help for more details +- -h, --help help for options +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/patch/help.md b/docs/http/json/patch/help.md new file mode 100644 index 0000000..e24820f --- /dev/null +++ b/docs/http/json/patch/help.md @@ -0,0 +1,28 @@ +# Call using HTTP PATCH + +## Usage: +```bash +Usage: + ./mgc http json patch [flags] +``` + +## Product catalog: +- Flags: +- --body anyOf (at least one of: boolean, string, number, integer, array or object) +- Use --body=help for more details +- --headers object Use --headers=help for more details +- -h, --help help for patch +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/post/help.md b/docs/http/json/post/help.md new file mode 100644 index 0000000..2ca4556 --- /dev/null +++ b/docs/http/json/post/help.md @@ -0,0 +1,28 @@ +# Call using HTTP POST + +## Usage: +```bash +Usage: + ./mgc http json post [flags] +``` + +## Product catalog: +- Flags: +- --body anyOf (at least one of: boolean, string, number, integer, array or object) +- Use --body=help for more details +- --headers object Use --headers=help for more details +- -h, --help help for post +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/put/help.md b/docs/http/json/put/help.md new file mode 100644 index 0000000..f22306d --- /dev/null +++ b/docs/http/json/put/help.md @@ -0,0 +1,28 @@ +# Call using HTTP PUT + +## Usage: +```bash +Usage: + ./mgc http json put [flags] +``` + +## Product catalog: +- Flags: +- --body anyOf (at least one of: boolean, string, number, integer, array or object) +- Use --body=help for more details +- --headers object Use --headers=help for more details +- -h, --help help for put +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/http/json/trace/help.md b/docs/http/json/trace/help.md new file mode 100644 index 0000000..5f7f723 --- /dev/null +++ b/docs/http/json/trace/help.md @@ -0,0 +1,26 @@ +# Call using HTTP TRACE + +## Usage: +```bash +Usage: + ./mgc http json trace [flags] +``` + +## Product catalog: +- Flags: +- --headers object Use --headers=help for more details +- -h, --help help for trace +- --security array(object) Use --security=help for more details +- --url string Golang template with the URL (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl-1", "br-ne-1" or "br-se-1") (default "br-ne-1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/cluster/create/help.md b/docs/kubernetes/cluster/create/help.md new file mode 100644 index 0000000..abf9bc2 --- /dev/null +++ b/docs/kubernetes/cluster/create/help.md @@ -0,0 +1,49 @@ +# Creates a Kubernetes cluster in Magalu Cloud. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster create [flags] +``` + +## Product catalog: +- Examples: +- ./mgc kubernetes cluster create --allowed-cidrs='["192.168.1.0/24","10.0.0.0/16"]' --description="This is an example cluster." --enabled-bastion=false --enabled-server-group=false --name="cluster-example" --node-pools='[{"auto_scale":{"max_replicas":5,"min_replicas":2},"flavor":"cloud-k8s.gp1.small","name":"nodepool-example","replicas":3,"tags":["tag-value1"],"taints":[{"effect":"NoSchedule","key":"example-key","value":"valor1"}]}]' --param.version="v1.30.2" --zone="br-region-zone" + +## Other commands: +- Flags: +- --allowed-cidrs array(string) List of allowed CIDR blocks for API server access. +- +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string A brief description of the Kubernetes cluster. +- +- --enabled-bastion Enables the use of a bastion host for secure access to the cluster. +- (required) +- --enabled-server-group Enables the use of a server group with anti-affinity policy during the creation of the cluster and its node pools. +- (default true) +- -h, --help help for create +- --name string Kubernetes cluster name. The name is primarily intended for idempotence, and must be unique within a namespace. The name cannot be changed. +- The name must follow the following rules: +- - must contain a maximum of 63 characters +- - must contain only lowercase alphanumeric characters or '-' +- - must start with an alphabetic character +- - must end with an alphanumeric character +- (required) +- --node-pools array(object) An array representing a set of nodes within a Kubernetes cluster. +- +- Use --node-pools=help for more details (required) +- --param.version string The native Kubernetes version of the cluster. +- Please specify the Kubernetes version using the standard "vX.Y.Z" format. +- (default "v1.30.2") +- -v, --version version for create +- --zone string Identifier of the zone where the Kubernetes cluster will be located. + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/kubernetes/cluster/delete/help.md b/docs/kubernetes/cluster/delete/help.md new file mode 100644 index 0000000..b2abd59 --- /dev/null +++ b/docs/kubernetes/cluster/delete/help.md @@ -0,0 +1,26 @@ +# Deletes a cluster by cluster_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster delete [cluster-id] [flags] +``` + +## Product catalog: +- Flags: +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for delete +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/cluster/get/help.md b/docs/kubernetes/cluster/get/help.md new file mode 100644 index 0000000..a58f869 --- /dev/null +++ b/docs/kubernetes/cluster/get/help.md @@ -0,0 +1,27 @@ +# Lists detailed cluster information by cluster_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster get [cluster-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for get +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/cluster/help.md b/docs/kubernetes/cluster/help.md new file mode 100644 index 0000000..65a25fb --- /dev/null +++ b/docs/kubernetes/cluster/help.md @@ -0,0 +1,28 @@ +# Endpoints related to the creation, listing, deletion, and retrieval of the kubeconfig for a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster [flags] + ./mgc kubernetes cluster [command] +``` + +## Product catalog: +- Commands: +- create Create a cluster +- delete Delete a cluster +- get List a cluster by uuid +- kubeconfig Get kubeconfig cluster +- list List all clusters + +## Other commands: +- Flags: +- -h, --help help for cluster +- -v, --version version for cluster + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/kubernetes/cluster/kubeconfig/help.md b/docs/kubernetes/cluster/kubeconfig/help.md new file mode 100644 index 0000000..40fa747 --- /dev/null +++ b/docs/kubernetes/cluster/kubeconfig/help.md @@ -0,0 +1,27 @@ +# Retrieves the kubeconfig of a Kubernetes cluster by cluster_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster kubeconfig [cluster-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Schema to get the cluster's kubeconfig file. (required) +- -h, --help help for kubeconfig +- -v, --version version for kubeconfig + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/cluster/list/help.md b/docs/kubernetes/cluster/list/help.md new file mode 100644 index 0000000..b789a4a --- /dev/null +++ b/docs/kubernetes/cluster/list/help.md @@ -0,0 +1,25 @@ +# Lists all clusters for a user. + +## Usage: +```bash +Usage: + ./mgc kubernetes cluster list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/flavor/help.md b/docs/kubernetes/flavor/help.md new file mode 100644 index 0000000..a4ba55b --- /dev/null +++ b/docs/kubernetes/flavor/help.md @@ -0,0 +1,24 @@ +# Endpoints related to listing available flavors for a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes flavor [flags] + ./mgc kubernetes flavor [command] +``` + +## Product catalog: +- Commands: +- list Lists all available flavors + +## Other commands: +- Flags: +- -h, --help help for flavor +- -v, --version version for flavor + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/kubernetes/flavor/list/help.md b/docs/kubernetes/flavor/list/help.md new file mode 100644 index 0000000..66700dc --- /dev/null +++ b/docs/kubernetes/flavor/list/help.md @@ -0,0 +1,25 @@ +# Lists all available flavors. + +## Usage: +```bash +Usage: + ./mgc kubernetes flavor list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/help.md b/docs/kubernetes/help.md new file mode 100644 index 0000000..f3daee6 --- /dev/null +++ b/docs/kubernetes/help.md @@ -0,0 +1,28 @@ +# APIs related to the Kubernetes product. + +## Usage: +```bash +Usage: + ./mgc kubernetes [flags] + ./mgc kubernetes [command] +``` + +## Product catalog: +- Aliases: +- kubernetes, k8s, kube, kub + +## Other commands: +- Commands: +- cluster Endpoints related to the creation, listing, deletion, and retrieval of the kubeconfig for a Kubernetes cluster. +- flavor Endpoints related to listing available flavors for a Kubernetes cluster. +- info Endpoints related to listing available flavors (resource configurations) and Kubernetes versions for a Kubernetes cluster. +- nodepool Endpoints related to the creation, listing of nodepools and nodes, updating, and deletion of nodepools for a Kubernetes cluster. +- version Endpoints related to listing available Kubernetes versions for a Kubernetes cluster. + +## Flags: +```bash +Flags: + -h, --help help for kubernetes + -v, --version version for kubernetes +``` + diff --git a/docs/kubernetes/info/flavors/help.md b/docs/kubernetes/info/flavors/help.md new file mode 100644 index 0000000..e8fee43 --- /dev/null +++ b/docs/kubernetes/info/flavors/help.md @@ -0,0 +1,25 @@ +# Lists all available flavors. + +## Usage: +```bash +Usage: + ./mgc kubernetes info flavors [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for flavors +- -v, --version version for flavors + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/info/help.md b/docs/kubernetes/info/help.md new file mode 100644 index 0000000..73137aa --- /dev/null +++ b/docs/kubernetes/info/help.md @@ -0,0 +1,25 @@ +# Endpoints related to listing available flavors (resource configurations) and Kubernetes versions for a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes info [flags] + ./mgc kubernetes info [command] +``` + +## Product catalog: +- Commands: +- flavors Lists all available flavors +- versions Lists all available versions + +## Other commands: +- Flags: +- -h, --help help for info +- -v, --version version for info + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/kubernetes/info/versions/help.md b/docs/kubernetes/info/versions/help.md new file mode 100644 index 0000000..860b840 --- /dev/null +++ b/docs/kubernetes/info/versions/help.md @@ -0,0 +1,25 @@ +# Lists all available Kubernetes versions. + +## Usage: +```bash +Usage: + ./mgc kubernetes info versions [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for versions +- -v, --version version for versions + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/nodepool/create/help.md b/docs/kubernetes/nodepool/create/help.md new file mode 100644 index 0000000..3655579 --- /dev/null +++ b/docs/kubernetes/nodepool/create/help.md @@ -0,0 +1,69 @@ +# Creates a node pool in a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool create [cluster-id] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc kubernetes nodepool create --auto-scale.max-replicas=5 --auto-scale.min-replicas=2 --flavor="cloud-k8s.gp1.small" --name="nodepool-example" --replicas=3 --tags='["tag-value1"]' + +## Other commands: +- Flags: +- --auto-scale object Object specifying properties for updating workload resources in the Kubernetes cluster. +- (properties: max_replicas and min_replicas) +- Use --auto-scale=help for more details +- --auto-scale.max-replicas integer Object specifying properties for updating workload resources in the Kubernetes cluster: Maximum number of replicas for autoscaling. If not provided, or if the value is equal to or less than zero, the autoscaler value will be assumed based on the "replicas" field. +- (min: 1) +- This is the same as '--auto-scale=max_replicas:integer'. (default 1) +- --auto-scale.min-replicas integer Object specifying properties for updating workload resources in the Kubernetes cluster: Minimum number of replicas for autoscaling. If not provided, or if the value is equal to or less than zero, the autoscaler value will be assumed based on the "replicas" field. +- (min: 1) +- This is the same as '--auto-scale=min_replicas:integer'. (default 1) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Cluster's UUID. (required) +- --flavor string Definition of the CPU, RAM, and storage capacity of the nodes. +- +- | Flavor | vCPUs | RAM (GB) | Root Disk (GB) | +- |----------------------------|-------|----------|----------------| +- | cloud-k8s.gp1.small | 2 | 4 | 20 | +- | cloud-k8s.gp1.medium | 4 | 8 | 50 | +- | cloud-k8s.gp1.large | 8 | 16 | 100 | +- | cloud-k8s.gp2.small | 2 | 4 | 300 | +- | cloud-k8s.gp2.large | 8 | 32 | 300 | +- | cloud-k8s.hm1.medium | 4 | 16 | 50 | +- | cloud-k8s.i1-c48-r96-d300 | 48 | 96 | 300 | +- | cloud-k8s.i1-c1-r8-d100 | 1 | 8 | 100 | +- | cloud-k8s.i1-c8-r8-d40 | 8 | 8 | 40 | +- | cloud-k8s.i1-c4-r16-d100 | 4 | 16 | 100 | +- | cloud-k8s.i1-c4-r32-d100 | 4 | 32 | 100 | +- | cloud-k8s.i1-c8-r32-d100 | 8 | 32 | 100 | +- | cloud-k8s.i1-c16-r32-d40 | 16 | 32 | 40 | +- | cloud-k8s.i1-c16-r64-d100 | 16 | 64 | 100 | +- | cloud-k8s.i1-c32-r64-d100 | 32 | 64 | 100 | +- | cloud-k8s.i1-c32-r128-d500 | 32 | 128 | 500 | +- (required) +- -h, --help help for create +- --name string Name of the node pool. The name is primarily for idempotence and must be unique within a namespace. The name cannot be changed. +- The name must follow the following rules: +- - Must contain a maximum of 63 characters +- - Must contain only lowercase alphanumeric characters or '-' +- - Must start with an alphabetic character +- - Must end with an alphanumeric character +- (required) +- --replicas integer Number of replicas of the nodes in the node pool. (required) (default 1) +- --tags array(string) List of tags applied to the node pool. +- --taints array(object) Property associating a set of nodes. +- Use --taints=help for more details +- -v, --version version for create + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/kubernetes/nodepool/delete/help.md b/docs/kubernetes/nodepool/delete/help.md new file mode 100644 index 0000000..f8d86b6 --- /dev/null +++ b/docs/kubernetes/nodepool/delete/help.md @@ -0,0 +1,27 @@ +# Deletes a node pool in a Kubernetes cluster by nodepool_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool delete [cluster-id] [node-pool-id] [flags] +``` + +## Product catalog: +- Flags: +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for delete +- --node-pool-id uuid Nodepool's UUID. (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/nodepool/get/help.md b/docs/kubernetes/nodepool/get/help.md new file mode 100644 index 0000000..b57d2d9 --- /dev/null +++ b/docs/kubernetes/nodepool/get/help.md @@ -0,0 +1,28 @@ +# Gets nodes in a node pool by nodepool_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool get [cluster-id] [node-pool-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for get +- --node-pool-id uuid Nodepool's UUID. (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/nodepool/help.md b/docs/kubernetes/nodepool/help.md new file mode 100644 index 0000000..35cc423 --- /dev/null +++ b/docs/kubernetes/nodepool/help.md @@ -0,0 +1,29 @@ +# Endpoints related to the creation, listing of nodepools and nodes, updating, and deletion of nodepools for a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool [flags] + ./mgc kubernetes nodepool [command] +``` + +## Product catalog: +- Commands: +- create Create a node pool +- delete Delete node pool by node_pool_id +- get Get node pool by node_pool_id +- list List node pools by cluster_id +- nodes List nodes from a node pool by node_pool_id +- update Patch node pool replicas by node_pool_id + +## Other commands: +- Flags: +- -h, --help help for nodepool +- -v, --version version for nodepool + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/kubernetes/nodepool/list/help.md b/docs/kubernetes/nodepool/list/help.md new file mode 100644 index 0000000..86fea8f --- /dev/null +++ b/docs/kubernetes/nodepool/list/help.md @@ -0,0 +1,26 @@ +# Gets a node pool from a Kubernetes cluster by cluster_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool list [cluster-id] [flags] +``` + +## Product catalog: +- Flags: +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/nodepool/nodes/help.md b/docs/kubernetes/nodepool/nodes/help.md new file mode 100644 index 0000000..a70460a --- /dev/null +++ b/docs/kubernetes/nodepool/nodes/help.md @@ -0,0 +1,28 @@ +# Lists nodes in a node pool by nodepool_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool nodes [cluster-id] [node-pool-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for nodes +- --node-pool-id uuid Nodepool's UUID. (required) +- -v, --version version for nodes + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/kubernetes/nodepool/update/help.md b/docs/kubernetes/nodepool/update/help.md new file mode 100644 index 0000000..b51b2a3 --- /dev/null +++ b/docs/kubernetes/nodepool/update/help.md @@ -0,0 +1,39 @@ +# Updates nodes from a node pool by nodepool_uuid. + +## Usage: +```bash +Usage: + ./mgc kubernetes nodepool update [cluster-id] [node-pool-id] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc kubernetes nodepool update --auto-scale.max-replicas=5 --auto-scale.min-replicas=2 + +## Other commands: +- Flags: +- --auto-scale object Object specifying properties for updating workload resources in the Kubernetes cluster. +- (properties: max_replicas and min_replicas) +- Use --auto-scale=help for more details +- --auto-scale.max-replicas integer Object specifying properties for updating workload resources in the Kubernetes cluster: Maximum number of replicas for autoscaling. If not provided, or if the value is equal to or less than zero, the autoscaler value will be assumed based on the "replicas" field. +- (min: 1) +- This is the same as '--auto-scale=max_replicas:integer'. (default 1) +- --auto-scale.min-replicas integer Object specifying properties for updating workload resources in the Kubernetes cluster: Minimum number of replicas for autoscaling. If not provided, or if the value is equal to or less than zero, the autoscaler value will be assumed based on the "replicas" field. +- (min: 1) +- This is the same as '--auto-scale=min_replicas:integer'. (default 1) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cluster-id uuid Cluster's UUID. (required) +- -h, --help help for update +- --node-pool-id uuid Nodepool's UUID. (required) +- --replicas integer Number of replicas of the nodes in the node pool. +- -v, --version version for update + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/kubernetes/version/help.md b/docs/kubernetes/version/help.md new file mode 100644 index 0000000..705f66f --- /dev/null +++ b/docs/kubernetes/version/help.md @@ -0,0 +1,24 @@ +# Endpoints related to listing available Kubernetes versions for a Kubernetes cluster. + +## Usage: +```bash +Usage: + ./mgc kubernetes version [flags] + ./mgc kubernetes version [command] +``` + +## Product catalog: +- Commands: +- list Lists all available versions + +## Other commands: +- Flags: +- -h, --help help for version +- -v, --version version for version + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/kubernetes/version/list/help.md b/docs/kubernetes/version/list/help.md new file mode 100644 index 0000000..fc697c3 --- /dev/null +++ b/docs/kubernetes/version/list/help.md @@ -0,0 +1,25 @@ +# Lists all available Kubernetes versions. + +## Usage: +```bash +Usage: + ./mgc kubernetes version list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/healthcheck/help.md b/docs/network/healthcheck/help.md new file mode 100644 index 0000000..7e9165a --- /dev/null +++ b/docs/network/healthcheck/help.md @@ -0,0 +1,24 @@ +# healthcheck + +## Usage: +```bash +Usage: + ./mgc network healthcheck [flags] + ./mgc network healthcheck [command] +``` + +## Product catalog: +- Commands: +- list Healthcheck + +## Other commands: +- Flags: +- -h, --help help for healthcheck +- -v, --version version for healthcheck + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/healthcheck/list/help.md b/docs/network/healthcheck/list/help.md new file mode 100644 index 0000000..d79b353 --- /dev/null +++ b/docs/network/healthcheck/list/help.md @@ -0,0 +1,25 @@ +# Check api status + +## Usage: +```bash +Usage: + ./mgc network healthcheck list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/help.md b/docs/network/help.md new file mode 100644 index 0000000..685565d --- /dev/null +++ b/docs/network/help.md @@ -0,0 +1,29 @@ +# APIs referentes ao produto de VPC + +## Usage: +```bash +Usage: + ./mgc network [flags] + ./mgc network [command] +``` + +## Product catalog: +- Commands: +- ports VPC Port +- public-ips VPC Public IPs +- rules VPC Rules +- security-groups VPC Security Groups +- subnets VPC Subnets +- vpcs Virtual Private Cloud (VPC) + +## Other commands: +- Flags: +- -h, --help help for network +- -v, --version version for network + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/ports/attach/help.md b/docs/network/ports/attach/help.md new file mode 100644 index 0000000..2bc5820 --- /dev/null +++ b/docs/network/ports/attach/help.md @@ -0,0 +1,28 @@ +# Attach a Security Group to a Port with provided port_id, security_group_id, x-tenant-id of an specific project type + +## Usage: +```bash +Usage: + ./mgc network ports attach [port-id] [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for attach +- --port-id string port_id: ID of the Port to attach security group (required) +- --security-group-id string security_group_id: ID of the Security Group to attach (required) +- -v, --version version for attach + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/create-default-vpc/help.md b/docs/network/ports/create-default-vpc/help.md new file mode 100644 index 0000000..ed46463 --- /dev/null +++ b/docs/network/ports/create-default-vpc/help.md @@ -0,0 +1,32 @@ +# Create a Port on the default VPC. Uses VPC default in the provided x-tenant-id. You can provide a list of security_groups_id or subnets. + +## Usage: +```bash +Usage: + ./mgc network ports create-default-vpc [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --has-pip Has Pip (default true) +- --has-sg Has Sg (default true) +- -h, --help help for create-default-vpc +- --name string Name (between 5 and 100 characters) (required) +- --security-groups-id array(string) Security Groups Id (default []) +- --subnets array(string) Subnets (default []) +- -v, --version version for create-default-vpc + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --x-zone string X-Zone + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/create/help.md b/docs/network/ports/create/help.md new file mode 100644 index 0000000..df37385 --- /dev/null +++ b/docs/network/ports/create/help.md @@ -0,0 +1,33 @@ +# Create a Port with provided vpc_id and x-tenant-id. You can provide a list of security_groups_id or subnets + +## Usage: +```bash +Usage: + ./mgc network ports create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --has-pip Has Pip (default true) +- --has-sg Has Sg (default true) +- -h, --help help for create +- --name string Name (between 5 and 100 characters) (required) +- --security-groups-id array(string) Security Groups Id (default []) +- --subnets array(string) Subnets (default []) +- -v, --version version for create +- --vpc-id string vpc_id: ID of the VPC to create port (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --x-zone string X-Zone + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/delete-all/help.md b/docs/network/ports/delete-all/help.md new file mode 100644 index 0000000..a63e1ec --- /dev/null +++ b/docs/network/ports/delete-all/help.md @@ -0,0 +1,25 @@ +# Delete a all ports from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network ports delete-all [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete-all +- -v, --version version for delete-all + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/delete/help.md b/docs/network/ports/delete/help.md new file mode 100644 index 0000000..7a139fb --- /dev/null +++ b/docs/network/ports/delete/help.md @@ -0,0 +1,26 @@ +# Delete a port from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network ports delete [port-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --port-id string port_id: ID of the Port to delete (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/detach/help.md b/docs/network/ports/detach/help.md new file mode 100644 index 0000000..2a861f8 --- /dev/null +++ b/docs/network/ports/detach/help.md @@ -0,0 +1,28 @@ +# Detach a Security Group to a Port with provided port_id, security_group_id, x-tenant-id of an specific project type + +## Usage: +```bash +Usage: + ./mgc network ports detach [port-id] [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for detach +- --port-id string port_id: ID of the Port to detach security group (required) +- --security-group-id string security_group_id: ID of the Security Group to detach (required) +- -v, --version version for detach + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/get/help.md b/docs/network/ports/get/help.md new file mode 100644 index 0000000..8cee440 --- /dev/null +++ b/docs/network/ports/get/help.md @@ -0,0 +1,27 @@ +# Return a port details from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network ports get [port-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --port-id string Port Id (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/help.md b/docs/network/ports/help.md new file mode 100644 index 0000000..a26c4fb --- /dev/null +++ b/docs/network/ports/help.md @@ -0,0 +1,29 @@ +# VPC Port + +## Usage: +```bash +Usage: + ./mgc network ports [flags] + ./mgc network ports [command] +``` + +## Product catalog: +- Commands: +- attach Attach Security Group +- create Create Port +- delete Delete Port +- detach Detach Security Group +- get Port Details +- list Details of a Port list + +## Other commands: +- Flags: +- -h, --help help for ports +- -v, --version version for ports + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/ports/list/help.md b/docs/network/ports/list/help.md new file mode 100644 index 0000000..1ae2f76 --- /dev/null +++ b/docs/network/ports/list/help.md @@ -0,0 +1,26 @@ +# Return a detailed list of ports from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network ports list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- --port-id-list array(string) Port Id List (default []) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/security-group-attachment/create/help.md b/docs/network/ports/security-group-attachment/create/help.md new file mode 100644 index 0000000..fbb147d --- /dev/null +++ b/docs/network/ports/security-group-attachment/create/help.md @@ -0,0 +1,27 @@ +# Attach a Security Group to a Port + +## Usage: +```bash +Usage: + ./mgc network ports security-group-attachment create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for create +- --port-id string port_id: ID of the Port to attach security group (required) +- --security-group-id string security_group_id: ID of the Security Group to attach (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/security-group-attachment/delete/help.md b/docs/network/ports/security-group-attachment/delete/help.md new file mode 100644 index 0000000..e36a0a2 --- /dev/null +++ b/docs/network/ports/security-group-attachment/delete/help.md @@ -0,0 +1,26 @@ +# Detach a Security Group from a Port + +## Usage: +```bash +Usage: + ./mgc network ports security-group-attachment delete [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --port-id string port_id: ID of the Port to attach security group (required) +- --security-group-id string security_group_id: ID of the Security Group to attach (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/security-group-attachment/get/help.md b/docs/network/ports/security-group-attachment/get/help.md new file mode 100644 index 0000000..0da58c3 --- /dev/null +++ b/docs/network/ports/security-group-attachment/get/help.md @@ -0,0 +1,26 @@ +# Check if a Public IP is attached to a Port + +## Usage: +```bash +Usage: + ./mgc network ports security-group-attachment get [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get +- --port-id string port_id: ID of the Port to attach security group (required) +- --security-group-id string security_group_id: ID of the Security Group to attach (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/ports/security-group-attachment/help.md b/docs/network/ports/security-group-attachment/help.md new file mode 100644 index 0000000..c429a98 --- /dev/null +++ b/docs/network/ports/security-group-attachment/help.md @@ -0,0 +1,25 @@ +# Manage the attachment between a Security Group and a Port + +## Usage: +```bash +Usage: + ./mgc network ports security-group-attachment [flags] + ./mgc network ports security-group-attachment [command] +``` + +## Product catalog: +- Commands: +- create Attach a Security Group to a Port +- delete Detach a Security Group from a Port +- get Check if a Public IP is attached to a Port + +## Other commands: +- Flags: +- -h, --help help for security-group-attachment + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/public_ips/attach/help.md b/docs/network/public_ips/attach/help.md new file mode 100644 index 0000000..a9bf850 --- /dev/null +++ b/docs/network/public_ips/attach/help.md @@ -0,0 +1,28 @@ +# Attach a Public IP to a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips attach [public-ip-id] [port-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for attach +- --port-id string Port ID: Id of the Port to attach the Public IP (required) +- --public-ip-id string Public IP ID: Id of the Public IP to attach port to (required) +- -v, --version version for attach + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/create/help.md b/docs/network/public_ips/create/help.md new file mode 100644 index 0000000..5758c4f --- /dev/null +++ b/docs/network/public_ips/create/help.md @@ -0,0 +1,31 @@ +# Create async Public IP in a VPC with provided vpc_id and x_tenant_id + +## Usage: +```bash +Usage: + ./mgc network public-ips create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- -h, --help help for create +- --validate-quota validateQuota: Validate the quota before creating the Public IP (default true) +- -v, --version version for create +- --vpc-id string Vpc ID: Id of the VPC to create the Public IP in (required) +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/delete/help.md b/docs/network/public_ips/delete/help.md new file mode 100644 index 0000000..b308c55 --- /dev/null +++ b/docs/network/public_ips/delete/help.md @@ -0,0 +1,26 @@ +# Delete a Public IP from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network public-ips delete [public-ip-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --public-ip-id string Public IP ID: Id of the Public IP to delete (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/detach/help.md b/docs/network/public_ips/detach/help.md new file mode 100644 index 0000000..8ba0d36 --- /dev/null +++ b/docs/network/public_ips/detach/help.md @@ -0,0 +1,28 @@ +# Detach a Public IP to a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips detach [public-ip-id] [port-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for detach +- --port-id string Port ID: Id of the Port to detach the Public IP (required) +- --public-ip-id string Public IP ID: Id of the Public IP to detach port to (required) +- -v, --version version for detach + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/get/help.md b/docs/network/public_ips/get/help.md new file mode 100644 index 0000000..2a00f27 --- /dev/null +++ b/docs/network/public_ips/get/help.md @@ -0,0 +1,27 @@ +# Return a Public IP details + +## Usage: +```bash +Usage: + ./mgc network public-ips get [public-ip-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --public-ip-id string Public IP ID: Id of the Public IP to retrieve (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/help.md b/docs/network/public_ips/help.md new file mode 100644 index 0000000..e861476 --- /dev/null +++ b/docs/network/public_ips/help.md @@ -0,0 +1,29 @@ +# VPC Public IPs + +## Usage: +```bash +Usage: + ./mgc network public-ips [flags] + ./mgc network public-ips [command] +``` + +## Product catalog: +- Aliases: +- public-ips, public_ips + +## Other commands: +- Commands: +- attach Attach Public IP +- create Create Public IP +- delete Delete Public IP +- detach Detach Public IP +- get Public IP Details +- list Tenant's public IP list + +## Flags: +```bash +Flags: + -h, --help help for public-ips + -v, --version version for public-ips +``` + diff --git a/docs/network/public_ips/list/help.md b/docs/network/public_ips/list/help.md new file mode 100644 index 0000000..fd55a28 --- /dev/null +++ b/docs/network/public_ips/list/help.md @@ -0,0 +1,25 @@ +# Return a tenant's public ip list + +## Usage: +```bash +Usage: + ./mgc network public-ips list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/port-attachment/create/help.md b/docs/network/public_ips/port-attachment/create/help.md new file mode 100644 index 0000000..6f9b80f --- /dev/null +++ b/docs/network/public_ips/port-attachment/create/help.md @@ -0,0 +1,27 @@ +# Attach a Public IP to a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips port-attachment create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for create +- --port-id string Port ID: Id of the Port to attach the Public IP (required) +- --public-ip-id string Public IP ID: Id of the Public IP to attach port to (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/port-attachment/delete/help.md b/docs/network/public_ips/port-attachment/delete/help.md new file mode 100644 index 0000000..eaebb86 --- /dev/null +++ b/docs/network/public_ips/port-attachment/delete/help.md @@ -0,0 +1,26 @@ +# Detach a Public IP from a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips port-attachment delete [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --port-id string Port ID: Id of the Port to attach the Public IP (required) +- --public-ip-id string Public IP ID: Id of the Public IP to attach port to (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/port-attachment/get/help.md b/docs/network/public_ips/port-attachment/get/help.md new file mode 100644 index 0000000..e7ddfee --- /dev/null +++ b/docs/network/public_ips/port-attachment/get/help.md @@ -0,0 +1,26 @@ +# Check if a Public IP is attached to a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips port-attachment get [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get +- --port-id string Port ID: Id of the Port to attach the Public IP (required) +- --public-ip-id string Public IP ID: Id of the Public IP to attach port to (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/public_ips/port-attachment/help.md b/docs/network/public_ips/port-attachment/help.md new file mode 100644 index 0000000..952a1d5 --- /dev/null +++ b/docs/network/public_ips/port-attachment/help.md @@ -0,0 +1,25 @@ +# Manage the attachment between a Public IP and a Port + +## Usage: +```bash +Usage: + ./mgc network public-ips port-attachment [flags] + ./mgc network public-ips port-attachment [command] +``` + +## Product catalog: +- Commands: +- create Attach a Public IP to a Port +- delete Detach a Public IP from a Port +- get Check if a Public IP is attached to a Port + +## Other commands: +- Flags: +- -h, --help help for port-attachment + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/quotas/help.md b/docs/network/quotas/help.md new file mode 100644 index 0000000..1cea06e --- /dev/null +++ b/docs/network/quotas/help.md @@ -0,0 +1,22 @@ +# VPC Quotas + +## Usage: +```bash +Usage: + ./mgc network quotas [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for quotas +- -v, --version version for quotas + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/network/quotas/list/help.md b/docs/network/quotas/list/help.md new file mode 100644 index 0000000..8d676e1 --- /dev/null +++ b/docs/network/quotas/list/help.md @@ -0,0 +1,26 @@ +# Return a list of selected usage quotas from a provided tenant + +## Usage: +```bash +Usage: + ./mgc network quotas list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- --quota-slug enum quota_slug: Service to check quota usage (one of "nics", "public_ips", "security_group_rules", "security_groups", "subnet_pools", "subnets" or "vpcs") (required) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/rules/create/help.md b/docs/network/rules/create/help.md new file mode 100644 index 0000000..8a5d44f --- /dev/null +++ b/docs/network/rules/create/help.md @@ -0,0 +1,37 @@ +# Create a Rule async, returning its ID. To monitor the creation progress, please check the status in the service message or implement polling.Either a remote_ip_prefix or a remote_group_id can be specified.With remote_ip_prefix, all IPs that match the criteria will be allowed.With remote_group_id, only the specified security group is allowed to communicatefollowing the specified protocol, direction and port_range_min/max + +## Usage: +```bash +Usage: + ./mgc network rules create [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --direction string Direction +- --ethertype string Ethertype +- -h, --help help for create +- --port-range-max integer Port Range Max +- --port-range-min integer Port Range Min +- --protocol string Protocol +- --remote-group-id string Remote Group Id +- --remote-ip-prefix string Remote Ip Prefix +- --security-group-id string Security Group ID: Id of the Security Group (required) +- --validate-quota validateQuota: Validate the quota before creating Rule (default true) +- -v, --version version for create +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/rules/delete/help.md b/docs/network/rules/delete/help.md new file mode 100644 index 0000000..de26d18 --- /dev/null +++ b/docs/network/rules/delete/help.md @@ -0,0 +1,26 @@ +# Delete a rule from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network rules delete [rule-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --rule-id string Rule ID: Id of the Rule (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/rules/get/help.md b/docs/network/rules/get/help.md new file mode 100644 index 0000000..2e838fc --- /dev/null +++ b/docs/network/rules/get/help.md @@ -0,0 +1,27 @@ +# Return a rule details + +## Usage: +```bash +Usage: + ./mgc network rules get [rule-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --rule-id string Rule ID: Id of the Rule (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/rules/help.md b/docs/network/rules/help.md new file mode 100644 index 0000000..af83d75 --- /dev/null +++ b/docs/network/rules/help.md @@ -0,0 +1,27 @@ +# VPC Rules + +## Usage: +```bash +Usage: + ./mgc network rules [flags] + ./mgc network rules [command] +``` + +## Product catalog: +- Commands: +- create Create Rule +- delete Delete a Rule +- get Rule Details +- list List Rules + +## Other commands: +- Flags: +- -h, --help help for rules +- -v, --version version for rules + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/rules/list/help.md b/docs/network/rules/list/help.md new file mode 100644 index 0000000..c2f13a9 --- /dev/null +++ b/docs/network/rules/list/help.md @@ -0,0 +1,26 @@ +# Returns a list of rules for a provided security_group_id + +## Usage: +```bash +Usage: + ./mgc network rules list [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- --security-group-id string Security Group ID: Id of the Security Group (required) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/create-default/help.md b/docs/network/security_groups/create-default/help.md new file mode 100644 index 0000000..0a9bd92 --- /dev/null +++ b/docs/network/security_groups/create-default/help.md @@ -0,0 +1,26 @@ +# Create a Security Group Default + +## Usage: +```bash +Usage: + ./mgc network security-groups create-default [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for create-default +- -v, --version version for create-default + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/create/help.md b/docs/network/security_groups/create/help.md new file mode 100644 index 0000000..c91cffb --- /dev/null +++ b/docs/network/security_groups/create/help.md @@ -0,0 +1,31 @@ +# Create a Security Group + +## Usage: +```bash +Usage: + ./mgc network security-groups create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- -h, --help help for create +- --name string Name (between 5 and 100 characters) (required) +- --validate-quota validateQuota: Validate the quota before creating Security Group (default true) +- -v, --version version for create +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/delete-all/help.md b/docs/network/security_groups/delete-all/help.md new file mode 100644 index 0000000..0b424f6 --- /dev/null +++ b/docs/network/security_groups/delete-all/help.md @@ -0,0 +1,25 @@ +# Delete all security groups from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network security-groups delete-all [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete-all +- -v, --version version for delete-all + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/delete/help.md b/docs/network/security_groups/delete/help.md new file mode 100644 index 0000000..a924c98 --- /dev/null +++ b/docs/network/security_groups/delete/help.md @@ -0,0 +1,26 @@ +# Delete a security group from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network security-groups delete [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --security-group-id string Security Group ID: Id of the security group to delete (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/get/help.md b/docs/network/security_groups/get/help.md new file mode 100644 index 0000000..f4da325 --- /dev/null +++ b/docs/network/security_groups/get/help.md @@ -0,0 +1,27 @@ +# Return a security group details + +## Usage: +```bash +Usage: + ./mgc network security-groups get [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --security-group-id string Security Group ID: Id of the security group to detail (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/help.md b/docs/network/security_groups/help.md new file mode 100644 index 0000000..c9fcac9 --- /dev/null +++ b/docs/network/security_groups/help.md @@ -0,0 +1,27 @@ +# VPC Security Groups + +## Usage: +```bash +Usage: + ./mgc network security-groups [flags] + ./mgc network security-groups [command] +``` + +## Product catalog: +- Aliases: +- security-groups, security_groups + +## Other commands: +- Commands: +- create Create Security Group +- delete Delete a security group +- get Security Group Details +- list List Security Groups by Tenant + +## Flags: +```bash +Flags: + -h, --help help for security-groups + -v, --version version for security-groups +``` + diff --git a/docs/network/security_groups/list/help.md b/docs/network/security_groups/list/help.md new file mode 100644 index 0000000..1ee8a86 --- /dev/null +++ b/docs/network/security_groups/list/help.md @@ -0,0 +1,25 @@ +# Returns a list of security groups for a provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network security-groups list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/rules/create/help.md b/docs/network/security_groups/rules/create/help.md new file mode 100644 index 0000000..4ee6935 --- /dev/null +++ b/docs/network/security_groups/rules/create/help.md @@ -0,0 +1,37 @@ +# Create a Rule async, returning its ID. To monitor the creation progress, please check the status in the service message or implement polling.Either a remote_ip_prefix or a remote_group_id can be specified.With remote_ip_prefix, all IPs that match the criteria will be allowed.With remote_group_id, only the specified security group is allowed to communicatefollowing the specified protocol, direction and port_range_min/max + +## Usage: +```bash +Usage: + ./mgc network security-groups rules create [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --direction string Direction +- --ethertype string Ethertype +- -h, --help help for create +- --port-range-max integer Port Range Max +- --port-range-min integer Port Range Min +- --protocol string Protocol +- --remote-group-id string Remote Group Id +- --remote-ip-prefix string Remote Ip Prefix +- --security-group-id string Security Group ID: Id of the Security Group (required) +- --validate-quota validateQuota: Validate the quota before creating Rule (default true) +- -v, --version version for create +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/rules/help.md b/docs/network/security_groups/rules/help.md new file mode 100644 index 0000000..02d3cc6 --- /dev/null +++ b/docs/network/security_groups/rules/help.md @@ -0,0 +1,22 @@ +# VPC Security Groups | rules + +## Usage: +```bash +Usage: + ./mgc network security-groups rules [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for rules +- -v, --version version for rules + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/network/security_groups/rules/list/help.md b/docs/network/security_groups/rules/list/help.md new file mode 100644 index 0000000..88ea1a1 --- /dev/null +++ b/docs/network/security_groups/rules/list/help.md @@ -0,0 +1,26 @@ +# Returns a list of rules for a provided security_group_id + +## Usage: +```bash +Usage: + ./mgc network security-groups rules list [security-group-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- --security-group-id string Security Group ID: Id of the Security Group (required) +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/help.md b/docs/network/subnets/help.md new file mode 100644 index 0000000..4e924a9 --- /dev/null +++ b/docs/network/subnets/help.md @@ -0,0 +1,24 @@ +# VPC Subnets + +## Usage: +```bash +Usage: + ./mgc network subnets [flags] + ./mgc network subnets [command] +``` + +## Product catalog: +- Commands: +- subnets subnets + +## Other commands: +- Flags: +- -h, --help help for subnets +- -v, --version version for subnets + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/subnets/subnets/delete/help.md b/docs/network/subnets/subnets/delete/help.md new file mode 100644 index 0000000..53f0805 --- /dev/null +++ b/docs/network/subnets/subnets/delete/help.md @@ -0,0 +1,26 @@ +# Delete a subnet from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network subnets subnets delete [subnet-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --subnet-id string Subnet Id: Id of the Subnet to delete (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/subnets/get/help.md b/docs/network/subnets/subnets/get/help.md new file mode 100644 index 0000000..0da3fb0 --- /dev/null +++ b/docs/network/subnets/subnets/get/help.md @@ -0,0 +1,27 @@ +# Returns a subnet details + +## Usage: +```bash +Usage: + ./mgc network subnets subnets get [subnet-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- --subnet-id string Subnet Id: Id of the Subnet to detail (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/subnets/help.md b/docs/network/subnets/subnets/help.md new file mode 100644 index 0000000..76df193 --- /dev/null +++ b/docs/network/subnets/subnets/help.md @@ -0,0 +1,26 @@ +# VPC Subnets | subnets + +## Usage: +```bash +Usage: + ./mgc network subnets subnets [flags] + ./mgc network subnets subnets [command] +``` + +## Product catalog: +- Commands: +- delete Delete a Subnet +- get Subnet Details +- update Update Subnet + +## Other commands: +- Flags: +- -h, --help help for subnets +- -v, --version version for subnets + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/subnets/subnets/update/help.md b/docs/network/subnets/subnets/update/help.md new file mode 100644 index 0000000..030ef67 --- /dev/null +++ b/docs/network/subnets/subnets/update/help.md @@ -0,0 +1,29 @@ +# Update a subnet from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network subnets subnets update [subnet-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- --dns-nameservers array(ipvanyaddress) Dns Nameservers (default []) +- -h, --help help for update +- --subnet-id string Subnet Id (required) +- -v, --version version for update + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/vpcs-subnets/create/help.md b/docs/network/subnets/vpcs-subnets/create/help.md new file mode 100644 index 0000000..ad2b3e0 --- /dev/null +++ b/docs/network/subnets/vpcs-subnets/create/help.md @@ -0,0 +1,33 @@ +# Create a Subnet + +## Usage: +```bash +Usage: + ./mgc network subnets vpcs-subnets create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cidr-block string Cidr Block +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- --dns-nameservers array(ipvanyaddress) Dns Nameservers (default []) +- -h, --help help for create +- --ip-version integer Ip Version (required) +- --name string Name (required) +- -v, --version version for create +- --vpc-id string Vpc Id: Id of the VPC to create Subnet (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --x-zone string X-Zone + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/vpcs-subnets/help.md b/docs/network/subnets/vpcs-subnets/help.md new file mode 100644 index 0000000..7569428 --- /dev/null +++ b/docs/network/subnets/vpcs-subnets/help.md @@ -0,0 +1,22 @@ +# VPC Subnets | vpcs-subnets + +## Usage: +```bash +Usage: + ./mgc network subnets vpcs-subnets [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for vpcs-subnets +- -v, --version version for vpcs-subnets + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/network/subnets/vpcs-subnets/list/help.md b/docs/network/subnets/vpcs-subnets/list/help.md new file mode 100644 index 0000000..6bd0fad --- /dev/null +++ b/docs/network/subnets/vpcs-subnets/list/help.md @@ -0,0 +1,26 @@ +# Returns a list of subnets for a provided vpc_id + +## Usage: +```bash +Usage: + ./mgc network subnets vpcs-subnets list [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list +- --vpc-id string Vpc Id: Id of the VPC to list Subnets (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/create-default/help.md b/docs/network/vpcs/create-default/help.md new file mode 100644 index 0000000..718db4d --- /dev/null +++ b/docs/network/vpcs/create-default/help.md @@ -0,0 +1,26 @@ +# Create Vpc Default + +## Usage: +```bash +Usage: + ./mgc network vpcs create-default [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for create-default +- -v, --version version for create-default + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/create/help.md b/docs/network/vpcs/create/help.md new file mode 100644 index 0000000..a3cf19d --- /dev/null +++ b/docs/network/vpcs/create/help.md @@ -0,0 +1,28 @@ +# Create a VPC + +## Usage: +```bash +Usage: + ./mgc network vpcs create [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- -h, --help help for create +- --name string Name (required) +- -v, --version version for create + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/delete-all/help.md b/docs/network/vpcs/delete-all/help.md new file mode 100644 index 0000000..78d1369 --- /dev/null +++ b/docs/network/vpcs/delete-all/help.md @@ -0,0 +1,25 @@ +# Delete all VPCs from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network vpcs delete-all [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete-all +- -v, --version version for delete-all + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/delete/help.md b/docs/network/vpcs/delete/help.md new file mode 100644 index 0000000..2fa32f6 --- /dev/null +++ b/docs/network/vpcs/delete/help.md @@ -0,0 +1,26 @@ +# Delete a VPC from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network vpcs delete [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- -v, --version version for delete +- --vpc-id string VPC Id: ID of the VPC to delete (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/get/help.md b/docs/network/vpcs/get/help.md new file mode 100644 index 0000000..9b7d8d8 --- /dev/null +++ b/docs/network/vpcs/get/help.md @@ -0,0 +1,27 @@ +# Return a VPC details + +## Usage: +```bash +Usage: + ./mgc network vpcs get [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- -h, --help help for get +- -v, --version version for get +- --vpc-id string VPC Id: ID of the VPC to detail (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/help.md b/docs/network/vpcs/help.md new file mode 100644 index 0000000..67e5ce7 --- /dev/null +++ b/docs/network/vpcs/help.md @@ -0,0 +1,29 @@ +# Virtual Private Cloud (VPC) + +## Usage: +```bash +Usage: + ./mgc network vpcs [flags] + ./mgc network vpcs [command] +``` + +## Product catalog: +- Commands: +- create Create VPC +- delete Delete VPC +- get VPC Details +- list List VPC +- ports ports +- public-ips public-ips + +## Other commands: +- Flags: +- -h, --help help for vpcs +- -v, --version version for vpcs + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/vpcs/list/help.md b/docs/network/vpcs/list/help.md new file mode 100644 index 0000000..6ead7f7 --- /dev/null +++ b/docs/network/vpcs/list/help.md @@ -0,0 +1,25 @@ +# Returns a list of VPCs for a provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network vpcs list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/ports/create/help.md b/docs/network/vpcs/ports/create/help.md new file mode 100644 index 0000000..3602505 --- /dev/null +++ b/docs/network/vpcs/ports/create/help.md @@ -0,0 +1,33 @@ +# Create a Port with provided vpc_id and x-tenant-id. You can provide a list of security_groups_id or subnets + +## Usage: +```bash +Usage: + ./mgc network vpcs ports create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --has-pip Has Pip (default true) +- --has-sg Has Sg (default true) +- -h, --help help for create +- --name string Name (between 5 and 100 characters) (required) +- --security-groups-id array(string) Security Groups Id (default []) +- --subnets array(string) Subnets (default []) +- -v, --version version for create +- --vpc-id string vpc_id: ID of the VPC to create port (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --x-zone string X-Zone + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/ports/help.md b/docs/network/vpcs/ports/help.md new file mode 100644 index 0000000..d8d13be --- /dev/null +++ b/docs/network/vpcs/ports/help.md @@ -0,0 +1,25 @@ +# Virtual Private Cloud (VPC) | ports + +## Usage: +```bash +Usage: + ./mgc network vpcs ports [flags] + ./mgc network vpcs ports [command] +``` + +## Product catalog: +- Commands: +- create Create Port +- list List Ports + +## Other commands: +- Flags: +- -h, --help help for ports +- -v, --version version for ports + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/vpcs/ports/list/help.md b/docs/network/vpcs/ports/list/help.md new file mode 100644 index 0000000..a4880a7 --- /dev/null +++ b/docs/network/vpcs/ports/list/help.md @@ -0,0 +1,30 @@ +# List VPC ports + +## Usage: +```bash +Usage: + ./mgc network vpcs ports list [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Items Per Page (min: 1) (default 10) +- --control.offset integer Page Number (min: 1) (default 1) +- --detailed Detailed (default true) +- -h, --help help for list +- --port-id-list array(string) Port Id List (default []) +- -v, --version version for list +- --vpc-id string vpc_id: ID of VPC to list ports (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/public-ips/create/help.md b/docs/network/vpcs/public-ips/create/help.md new file mode 100644 index 0000000..02cc226 --- /dev/null +++ b/docs/network/vpcs/public-ips/create/help.md @@ -0,0 +1,31 @@ +# Create async Public IP in a VPC with provided vpc_id and x_tenant_id + +## Usage: +```bash +Usage: + ./mgc network vpcs public-ips create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- -h, --help help for create +- --validate-quota validateQuota: Validate the quota before creating the Public IP (default true) +- -v, --version version for create +- --vpc-id string Vpc ID: Id of the VPC to create the Public IP in (required) +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/public-ips/help.md b/docs/network/vpcs/public-ips/help.md new file mode 100644 index 0000000..ca4f9b2 --- /dev/null +++ b/docs/network/vpcs/public-ips/help.md @@ -0,0 +1,24 @@ +# Virtual Private Cloud (VPC) | public-ips + +## Usage: +```bash +Usage: + ./mgc network vpcs public-ips [flags] + ./mgc network vpcs public-ips [command] +``` + +## Product catalog: +- Commands: +- list List Public IPs + +## Other commands: +- Flags: +- -h, --help help for public-ips +- -v, --version version for public-ips + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/vpcs/public-ips/list/help.md b/docs/network/vpcs/public-ips/list/help.md new file mode 100644 index 0000000..0a78a3a --- /dev/null +++ b/docs/network/vpcs/public-ips/list/help.md @@ -0,0 +1,26 @@ +# Returns a list of Public IPs for a provided vpc_id + +## Usage: +```bash +Usage: + ./mgc network vpcs public-ips list [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list +- --vpc-id string Vpc ID: Id of the VPC to list the Public IPs in (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/security-groups/create/help.md b/docs/network/vpcs/security-groups/create/help.md new file mode 100644 index 0000000..40f12ad --- /dev/null +++ b/docs/network/vpcs/security-groups/create/help.md @@ -0,0 +1,31 @@ +# Create a Security Group + +## Usage: +```bash +Usage: + ./mgc network vpcs security-groups create [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --description string Description +- -h, --help help for create +- --name string Name (between 5 and 100 characters) (required) +- -v, --version version for create +- --vpc-id string VPC Id: Id of the vpc to create the security group in (required) +- --wait The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter (default true) +- --wait-timeout integer waitTimeout: the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true) (default 120) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/security-groups/help.md b/docs/network/vpcs/security-groups/help.md new file mode 100644 index 0000000..11796b6 --- /dev/null +++ b/docs/network/vpcs/security-groups/help.md @@ -0,0 +1,22 @@ +# Virtual Private Cloud (VPC) | security-groups + +## Usage: +```bash +Usage: + ./mgc network vpcs security-groups [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for security-groups +- -v, --version version for security-groups + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/network/vpcs/security-groups/list/help.md b/docs/network/vpcs/security-groups/list/help.md new file mode 100644 index 0000000..8944d18 --- /dev/null +++ b/docs/network/vpcs/security-groups/list/help.md @@ -0,0 +1,26 @@ +# Returns a list of security groups for a provided vpc_id + +## Usage: +```bash +Usage: + ./mgc network vpcs security-groups list [vpc-id] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list +- -v, --version version for list +- --vpc-id string Vpc ID: Id of the VPC to create the Security Group in (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/network/worker_public_ips/help.md b/docs/network/worker_public_ips/help.md new file mode 100644 index 0000000..0d30b15 --- /dev/null +++ b/docs/network/worker_public_ips/help.md @@ -0,0 +1,23 @@ +# worker_public_ips + +## Usage: +```bash +Usage: + ./mgc network worker-public-ips [flags] +``` + +## Product catalog: +- Aliases: +- worker-public-ips, worker_public_ips + +## Other commands: +- Flags: +- -h, --help help for worker-public-ips +- -v, --version version for worker-public-ips + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/network/worker_public_ips/update/help.md b/docs/network/worker_public_ips/update/help.md new file mode 100644 index 0000000..71b535c --- /dev/null +++ b/docs/network/worker_public_ips/update/help.md @@ -0,0 +1,30 @@ +# Update a public ip from the provided tenant_id + +## Usage: +```bash +Usage: + ./mgc network worker-public-ips update [public-ip-id] [flags] +``` + +## Product catalog: +- Flags: +- --error string Error +- --external-id string External Id +- -h, --help help for update +- --public-ip string Public Ip +- --public-ip-id string Public Ip Id: Id of the public ip to update (required) +- --status enum PublicIpStatus (one of "created", "error" or "pending") (required) +- -v, --version version for update + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/add/help.md b/docs/object-storage/api-key/add/help.md new file mode 100644 index 0000000..53b50d6 --- /dev/null +++ b/docs/object-storage/api-key/add/help.md @@ -0,0 +1,23 @@ +# Change current Object Storage credential + +## Usage: +```bash +Usage: + ./mgc object-storage api-key add [key-id] [key-secret] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for add +- --key-id string ID of api key to use (required) +- --key-secret string Secret of api key to use (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/create/help.md b/docs/object-storage/api-key/create/help.md new file mode 100644 index 0000000..9ffe65b --- /dev/null +++ b/docs/object-storage/api-key/create/help.md @@ -0,0 +1,25 @@ +# Create new credentials used for Object Storage requests + +## Usage: +```bash +Usage: + ./mgc object-storage api-key create [name] [description] [expiration] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage api-key create --expiration="2024-11-07 (YYYY-MM-DD)" + +## Other commands: +- Flags: +- --description string Description of new api key +- --expiration string Date to expire new api +- -h, --help help for create +- --name string Name of new api key (required) + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/api-key/current/help.md b/docs/object-storage/api-key/current/help.md new file mode 100644 index 0000000..1b6b0eb --- /dev/null +++ b/docs/object-storage/api-key/current/help.md @@ -0,0 +1,21 @@ +# Get the current Object Storage credentials + +## Usage: +```bash +Usage: + ./mgc object-storage api-key current [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for current + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/get/help.md b/docs/object-storage/api-key/get/help.md new file mode 100644 index 0000000..ca6db5d --- /dev/null +++ b/docs/object-storage/api-key/get/help.md @@ -0,0 +1,22 @@ +# Get details about a specific key + +## Usage: +```bash +Usage: + ./mgc object-storage api-key get [uuid] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get +- --uuid string (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/help.md b/docs/object-storage/api-key/help.md new file mode 100644 index 0000000..3f1543c --- /dev/null +++ b/docs/object-storage/api-key/help.md @@ -0,0 +1,28 @@ +# Manage credentials to use Object Storage + +## Usage: +```bash +Usage: + ./mgc object-storage api-key [flags] + ./mgc object-storage api-key [command] +``` + +## Product catalog: +- Commands: +- create Create new credentials used for Object Storage requests +- current Get the current Object Storage credentials +- get Get details about a specific key +- list List valid Object Storage credentials +- revoke Revoke credentials used in Object Storage requests +- set Change current Object Storage credential to selected + +## Other commands: +- Additional Commands: +- select call "list", prompt selection and then "set" + +## Flags: +```bash +Flags: + -h, --help help for api-key +``` + diff --git a/docs/object-storage/api-key/list/help.md b/docs/object-storage/api-key/list/help.md new file mode 100644 index 0000000..7b27ed1 --- /dev/null +++ b/docs/object-storage/api-key/list/help.md @@ -0,0 +1,21 @@ +# List valid Object Storage credentials + +## Usage: +```bash +Usage: + ./mgc object-storage api-key list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/revoke/help.md b/docs/object-storage/api-key/revoke/help.md new file mode 100644 index 0000000..33f3b19 --- /dev/null +++ b/docs/object-storage/api-key/revoke/help.md @@ -0,0 +1,22 @@ +# Revoke credentials used in Object Storage requests + +## Usage: +```bash +Usage: + ./mgc object-storage api-key revoke [uuid] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for revoke +- --uuid string UUID of api key to revoke (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/api-key/set/help.md b/docs/object-storage/api-key/set/help.md new file mode 100644 index 0000000..38b11d5 --- /dev/null +++ b/docs/object-storage/api-key/set/help.md @@ -0,0 +1,22 @@ +# Change current Object Storage credential to selected + +## Usage: +```bash +Usage: + ./mgc object-storage api-key set [uuid] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for set +- --uuid string UUID of api key to select (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/acl/get/help.md b/docs/object-storage/buckets/acl/get/help.md new file mode 100644 index 0000000..3f7576e --- /dev/null +++ b/docs/object-storage/buckets/acl/get/help.md @@ -0,0 +1,26 @@ +# Get the ACL for the specified bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets acl get [dst] [flags] +``` + +## Product catalog: +- Flags: +- --dst string Specifies the bucket whose ACL is being requested (required) +- -h, --help help for get + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/acl/help.md b/docs/object-storage/buckets/acl/help.md new file mode 100644 index 0000000..dd8d5a0 --- /dev/null +++ b/docs/object-storage/buckets/acl/help.md @@ -0,0 +1,24 @@ +# ACL-related commands + +## Usage: +```bash +Usage: + ./mgc object-storage buckets acl [flags] + ./mgc object-storage buckets acl [command] +``` + +## Product catalog: +- Commands: +- get Get the ACL for the specified bucket +- set set permission information for the specified bucket + +## Other commands: +- Flags: +- -h, --help help for acl + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/buckets/acl/set/help.md b/docs/object-storage/buckets/acl/set/help.md new file mode 100644 index 0000000..3caa091 --- /dev/null +++ b/docs/object-storage/buckets/acl/set/help.md @@ -0,0 +1,31 @@ +# set permission information for the specified bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets acl set [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage buckets acl set --dst="my-bucket" + +## Other commands: +- Flags: +- --dst string Name of the bucket to set permissions for (required) +- --grant-write array(object) Allows grantees to create objects in the bucket +- Use --grant-write=help for more details +- -h, --help help for set +- --private Owner gets FULL_CONTROL. Delegated users have access. No one else has access rights +- --public-read Owner gets FULL_CONTROL. Everyone else has READ rights + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/buckets/create/help.md b/docs/object-storage/buckets/create/help.md new file mode 100644 index 0000000..21bc166 --- /dev/null +++ b/docs/object-storage/buckets/create/help.md @@ -0,0 +1,32 @@ +# Buckets are "containers" that are able to store various Objects inside + +## Usage: +```bash +Usage: + ./mgc object-storage buckets create [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Name of the bucket to be created (required) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --enable-versioning Enable versioning for this bucket (default true) +- --grant-write array(object) Allows grantees to create objects in the bucket +- Use --grant-write=help for more details +- -h, --help help for create +- --private Owner gets FULL_CONTROL. Delegated users have access. No one else has access rights +- --public-read Owner gets FULL_CONTROL. Everyone else has READ rights + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/delete/help.md b/docs/object-storage/buckets/delete/help.md new file mode 100644 index 0000000..b01393e --- /dev/null +++ b/docs/object-storage/buckets/delete/help.md @@ -0,0 +1,27 @@ +# Delete an existing Bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets delete [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Name of the bucket to be deleted (required) +- -h, --help help for delete +- --recursive Delete bucket including objects inside (required) + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/get/help.md b/docs/object-storage/buckets/get/help.md new file mode 100644 index 0000000..68b72ae --- /dev/null +++ b/docs/object-storage/buckets/get/help.md @@ -0,0 +1,26 @@ +# Get bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets get [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Name of the bucket to be created (required) +- -h, --help help for get + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/help.md b/docs/object-storage/buckets/help.md new file mode 100644 index 0000000..3041ff2 --- /dev/null +++ b/docs/object-storage/buckets/help.md @@ -0,0 +1,28 @@ +# Bucket operations for Object Storage API + +## Usage: +```bash +Usage: + ./mgc object-storage buckets [flags] + ./mgc object-storage buckets [command] +``` + +## Product catalog: +- Commands: +- acl ACL-related commands +- create Create a new Bucket +- delete Delete an existing Bucket +- list List all existing Buckets +- public-url Get bucket public url +- versioning Manage bucket versioning + +## Other commands: +- Flags: +- -h, --help help for buckets + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/buckets/list/help.md b/docs/object-storage/buckets/list/help.md new file mode 100644 index 0000000..d3933b1 --- /dev/null +++ b/docs/object-storage/buckets/list/help.md @@ -0,0 +1,25 @@ +# List all existing Buckets + +## Usage: +```bash +Usage: + ./mgc object-storage buckets list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/public-url/help.md b/docs/object-storage/buckets/public-url/help.md new file mode 100644 index 0000000..32a5ad6 --- /dev/null +++ b/docs/object-storage/buckets/public-url/help.md @@ -0,0 +1,27 @@ +# Get bucket public url + +## Usage: +```bash +Usage: + ./mgc object-storage buckets public-url [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage buckets public-url --dst="bucket1" + +## Other commands: +- Flags: +- --dst uri Path of the bucket to generate the public url (required) +- -h, --help help for public-url + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/buckets/versioning/enable/help.md b/docs/object-storage/buckets/versioning/enable/help.md new file mode 100644 index 0000000..1b8091c --- /dev/null +++ b/docs/object-storage/buckets/versioning/enable/help.md @@ -0,0 +1,26 @@ +# Enable versioning for a Bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets versioning enable [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Bucket name to enable versioning (required) +- -h, --help help for enable + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/versioning/get/help.md b/docs/object-storage/buckets/versioning/get/help.md new file mode 100644 index 0000000..142c595 --- /dev/null +++ b/docs/object-storage/buckets/versioning/get/help.md @@ -0,0 +1,26 @@ +# Get versioning info for a Bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets versioning get [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Bucket name to get versioning info from (required) +- -h, --help help for get + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/buckets/versioning/help.md b/docs/object-storage/buckets/versioning/help.md new file mode 100644 index 0000000..bbb60d7 --- /dev/null +++ b/docs/object-storage/buckets/versioning/help.md @@ -0,0 +1,25 @@ +# Manage bucket versioning + +## Usage: +```bash +Usage: + ./mgc object-storage buckets versioning [flags] + ./mgc object-storage buckets versioning [command] +``` + +## Product catalog: +- Commands: +- enable Enable versioning for a Bucket +- get Get versioning info for a Bucket +- suspend Suspend versioning for a Bucket + +## Other commands: +- Flags: +- -h, --help help for versioning + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/buckets/versioning/suspend/help.md b/docs/object-storage/buckets/versioning/suspend/help.md new file mode 100644 index 0000000..00eefa9 --- /dev/null +++ b/docs/object-storage/buckets/versioning/suspend/help.md @@ -0,0 +1,26 @@ +# Suspend versioning for a Bucket + +## Usage: +```bash +Usage: + ./mgc object-storage buckets versioning suspend [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --bucket string Bucket name to suspend versioning (required) +- -h, --help help for suspend + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/help.md b/docs/object-storage/help.md new file mode 100644 index 0000000..05f5ae3 --- /dev/null +++ b/docs/object-storage/help.md @@ -0,0 +1,25 @@ +# Create and manage Buckets and Objects via the Object Storage API + +## Usage: +```bash +Usage: + ./mgc object-storage [flags] + ./mgc object-storage [command] +``` + +## Product catalog: +- Aliases: +- object-storage, object, objs + +## Other commands: +- Commands: +- api-key Manage credentials to use Object Storage +- buckets Bucket operations for Object Storage API +- objects Object operations for Object Storage API + +## Flags: +```bash +Flags: + -h, --help help for object-storage +``` + diff --git a/docs/object-storage/objects/acl/get/help.md b/docs/object-storage/objects/acl/get/help.md new file mode 100644 index 0000000..a4a2c29 --- /dev/null +++ b/docs/object-storage/objects/acl/get/help.md @@ -0,0 +1,26 @@ +# Get ACL information for the specified object + +## Usage: +```bash +Usage: + ./mgc object-storage objects acl get [dst] [flags] +``` + +## Product catalog: +- Flags: +- --dst uri The full object URL to get the ACL information from (required) +- -h, --help help for get + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash +** object = "id:" (require tenant ID) - Example:id="a4900b57-7dbb-4906-b7e8-efed938e325c" +``` + diff --git a/docs/object-storage/objects/acl/help.md b/docs/object-storage/objects/acl/help.md new file mode 100644 index 0000000..0f7dc11 --- /dev/null +++ b/docs/object-storage/objects/acl/help.md @@ -0,0 +1,24 @@ +# ACL related operations + +## Usage: +```bash +Usage: + ./mgc object-storage objects acl [flags] + ./mgc object-storage objects acl [command] +``` + +## Product catalog: +- Commands: +- get Get ACL information for the specified object +- set Set ACL information for the specified object + +## Other commands: +- Flags: +- -h, --help help for acl + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/objects/acl/set/help.md b/docs/object-storage/objects/acl/set/help.md new file mode 100644 index 0000000..92fd37e --- /dev/null +++ b/docs/object-storage/objects/acl/set/help.md @@ -0,0 +1,30 @@ +# Set ACL information for the specified object + +## Usage: +```bash +Usage: + ./mgc object-storage objects acl set [dst] [flags] +``` + +## Product catalog: +- Flags: +- --dst uri The full object URL to set the ACL information (required) +- --grant-write array(object) Allows grantees to create objects in the bucket +- Use --grant-write=help for more details +- -h, --help help for set +- --private Owner gets FULL_CONTROL. Delegated users have access. No one else has access rights +- --public-read Owner gets FULL_CONTROL. Everyone else has READ rights + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/objects/copy-all/help.md b/docs/object-storage/objects/copy-all/help.md new file mode 100644 index 0000000..5b18989 --- /dev/null +++ b/docs/object-storage/objects/copy-all/help.md @@ -0,0 +1,31 @@ +# Copy all objects from a bucket to another bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects copy-all [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects copy-all --dst="bucket2/dir/" --src="bucket1" --storage-class="cold" + +## Other commands: +- Flags: +- --dst uri Full destination path in the bucket (required) +- --filter array(object) File name pattern to include or exclude +- Use --filter=help for more details +- -h, --help help for copy-all +- --src uri Path of objects in a bucket to be copied (required) +- --storage-class enum Copy objects to other storage classes (one of "", "cold", "cold_instant", "glacier_ir" or "standard") (default "") + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/copy/help.md b/docs/object-storage/objects/copy/help.md new file mode 100644 index 0000000..cff67d5 --- /dev/null +++ b/docs/object-storage/objects/copy/help.md @@ -0,0 +1,30 @@ +# Copy an object from a bucket to another bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects copy [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects copy --dst="bucket2/dir/file.txt" --src="bucket1/file.txt" --storage-class="cold" + +## Other commands: +- Flags: +- --dst uri Full destination path in the bucket with desired filename (required) +- -h, --help help for copy +- --obj-version string Version of the object to be copied +- --src uri Path of the object in a bucket to be copied (required) +- --storage-class enum Copy objects to other storage classes (one of "", "cold", "cold_instant", "glacier_ir" or "standard") (default "") + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/delete-all/help.md b/docs/object-storage/objects/delete-all/help.md new file mode 100644 index 0000000..49d0b30 --- /dev/null +++ b/docs/object-storage/objects/delete-all/help.md @@ -0,0 +1,29 @@ +# Delete all objects from a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects delete-all [bucket] [flags] +``` + +## Product catalog: +- Flags: +- --batch-size integer Limit of items per batch to delete (range: 1 - 1000) (default 1000) +- --bucket string Name of the bucket to delete objects from (required) +- --filter array(object) File name pattern to include or exclude +- Use --filter=help for more details +- -h, --help help for delete-all + +## Other commands: +- Global Flags: +- --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) +- --cli.show-cli-globals Show all CLI global flags on usage text +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use +- --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) + +## Flags: +```bash + +``` + diff --git a/docs/object-storage/objects/delete/help.md b/docs/object-storage/objects/delete/help.md new file mode 100644 index 0000000..0260237 --- /dev/null +++ b/docs/object-storage/objects/delete/help.md @@ -0,0 +1,28 @@ +# Delete an object from a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects delete [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects delete --dst="bucket1/file.txt" + +## Other commands: +- Flags: +- --dst uri Path of the object to be deleted (required) +- -h, --help help for delete +- --obj-version string Version of the object to be deleted + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/download-all/help.md b/docs/object-storage/objects/download-all/help.md new file mode 100644 index 0000000..36e6c19 --- /dev/null +++ b/docs/object-storage/objects/download-all/help.md @@ -0,0 +1,30 @@ +# Download all objects from a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects download-all [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects download-all --dst="path/to/folder" --src="mybucket" + +## Other commands: +- Flags: +- --dst file Path to save files +- --filter array(object) File name pattern to include or exclude +- Use --filter=help for more details +- -h, --help help for download-all +- --src uri Path of objects to be downloaded (required) + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/download/help.md b/docs/object-storage/objects/download/help.md new file mode 100644 index 0000000..c566a76 --- /dev/null +++ b/docs/object-storage/objects/download/help.md @@ -0,0 +1,29 @@ +# Download an object from a bucket. If no destination is specified, the default is the current working directory + +## Usage: +```bash +Usage: + ./mgc object-storage objects download [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects download --dst="file.txt" --src="bucket1/file.txt" + +## Other commands: +- Flags: +- --dst file Path and file name to be saved (relative or absolute).If not specified it defaults to the current working directory +- -h, --help help for download +- --obj-version string Version of the object to be downloaded +- --src uri Path of the object to be downloaded (required) + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/head/help.md b/docs/object-storage/objects/head/help.md new file mode 100644 index 0000000..30055bf --- /dev/null +++ b/docs/object-storage/objects/head/help.md @@ -0,0 +1,28 @@ +# Get object metadata + +## Usage: +```bash +Usage: + ./mgc object-storage objects head [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects head --dst="bucket1/file.txt" + +## Other commands: +- Flags: +- --dst uri Path of the object to be get metadata from (required) +- -h, --help help for head +- --obj-version string Version of the object to be get metadata from + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/help.md b/docs/object-storage/objects/help.md new file mode 100644 index 0000000..d70450d --- /dev/null +++ b/docs/object-storage/objects/help.md @@ -0,0 +1,39 @@ +# Object operations for Object Storage API + +## Usage: +```bash +Usage: + ./mgc object-storage objects [flags] + ./mgc object-storage objects [command] +``` + +## Product catalog: +- Commands: +- acl ACL related operations +- copy Copy an object from a bucket to another bucket +- copy-all Copy all objects from a bucket to another bucket +- delete Delete an object from a bucket +- delete-all Delete all objects from a bucket +- download Download an object from a bucket +- download-all Download all objects from a bucket +- head Get object metadata +- list List all objects from a bucket +- move Moves one object from source to destination +- move-dir Moves objects from source to destination +- presign Generate a pre-signed URL for accessing an object +- public-url Get object public url +- sync Synchronizes a local path with a bucket +- upload Upload a file to a bucket +- upload-dir Upload a directory to a bucket +- versions Retrieve all versions of an object + +## Other commands: +- Flags: +- -h, --help help for objects + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/object-storage/objects/list/help.md b/docs/object-storage/objects/list/help.md new file mode 100644 index 0000000..b5a3acd --- /dev/null +++ b/docs/object-storage/objects/list/help.md @@ -0,0 +1,32 @@ +# List all objects from a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects list [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects list --dst="bucket1" --max-items=1000 + +## Other commands: +- Flags: +- --continuation-token string Token of result page to continue from +- --dst uri Path of the bucket to list objects from (required) +- --filter array(object) File name pattern to include or exclude +- Use --filter=help for more details +- -h, --help help for list +- --max-items integer Limit of items to be listed (min: 1) (default 1000) +- --recursive List folders and subfolders + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/move-dir/help.md b/docs/object-storage/objects/move-dir/help.md new file mode 100644 index 0000000..ae515fa --- /dev/null +++ b/docs/object-storage/objects/move-dir/help.md @@ -0,0 +1,30 @@ +# Moves objects from a source to a destination. +They can be either local or remote but not both local (Local -> Remote, Remote -> Local, Remote -> Remote) + +## Usage: +```bash +Usage: + ./mgc object-storage objects move-dir [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects move-dir --dst="s3://my-bucket/dir" --src="./dir" + +## Other commands: +- Flags: +- --batch-size integer Limit of items per batch to process (range: 1 - 1000) (default 1000) +- --dst uri Destination to put files into (required) +- -h, --help help for move-dir +- --src uri Source path or uri to move files from (required) + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/move/help.md b/docs/object-storage/objects/move/help.md new file mode 100644 index 0000000..032ba04 --- /dev/null +++ b/docs/object-storage/objects/move/help.md @@ -0,0 +1,29 @@ +# Moves one object from a source to a destination. +It can be either local or remote but not both local (Local -> Remote, Remote -> Local, Remote -> Remote) + +## Usage: +```bash +Usage: + ./mgc object-storage objects move [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects move --dst="s3://my-bucket/test.txt" --src="./hello.txt" + +## Other commands: +- Flags: +- --dst uri Destination to put the file into (required) +- -h, --help help for move +- --src uri A file to move to the Destination (required) + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/presign/help.md b/docs/object-storage/objects/presign/help.md new file mode 100644 index 0000000..82f057b --- /dev/null +++ b/docs/object-storage/objects/presign/help.md @@ -0,0 +1,29 @@ +# Generate a pre-signed URL for accessing an object + +## Usage: +```bash +Usage: + ./mgc object-storage objects presign [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects presign --dst="bucket1/file.txt" --expires-in="2h" + +## Other commands: +- Flags: +- --dst uri Path of the object to generate pre-signed URL for (required) +- --expires-in string Expiration time for the pre-signed URL. Valid time units are 'ns, 'us' (or 'µs'), 'ms', 's', 'm', and 'h'.default=5m +- -h, --help help for presign +- --method enum (one of "GET" or "PUT") (required) (default "GET") + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/public-url/help.md b/docs/object-storage/objects/public-url/help.md new file mode 100644 index 0000000..036d092 --- /dev/null +++ b/docs/object-storage/objects/public-url/help.md @@ -0,0 +1,27 @@ +# Get object public url + +## Usage: +```bash +Usage: + ./mgc object-storage objects public-url [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects public-url --dst="bucket1/file.txt" + +## Other commands: +- Flags: +- --dst uri Path of the object to generate the public url (required) +- -h, --help help for public-url + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/sync/help.md b/docs/object-storage/objects/sync/help.md new file mode 100644 index 0000000..b2074c1 --- /dev/null +++ b/docs/object-storage/objects/sync/help.md @@ -0,0 +1,30 @@ +# This command uploads any file from the local path to the bucket if it is not already present or has modified time changed. + +## Usage: +```bash +Usage: + ./mgc object-storage objects sync [local] [bucket] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects sync --bucket="my-bucket/dir/" --local="./" + +## Other commands: +- Flags: +- --batch-size integer Limit of items per batch to delete (range: 1 - 1000) (default 1000) +- --bucket uri Bucket path (required) +- --delete Deletes any item at the bucket not present on the local +- -h, --help help for sync +- --local uri Local path (required) + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/upload-dir/help.md b/docs/object-storage/objects/upload-dir/help.md new file mode 100644 index 0000000..019c0b3 --- /dev/null +++ b/docs/object-storage/objects/upload-dir/help.md @@ -0,0 +1,32 @@ +# Upload a directory to a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects upload-dir [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects upload-dir --dst="my-bucket/dir/" --src="path/to/folder" --storage-class="cold" + +## Other commands: +- Flags: +- --dst uri Full destination path in the bucket (required) +- --filter array(object) File name pattern to include or exclude +- Use --filter=help for more details +- -h, --help help for upload-dir +- --shallow Don't upload subdirectories +- --src directory Source directory path for upload (required) +- --storage-class enum Type of Storage in which to store object (one of "", "cold", "cold_instant", "glacier_ir" or "standard") (default "") + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/upload/help.md b/docs/object-storage/objects/upload/help.md new file mode 100644 index 0000000..432417f --- /dev/null +++ b/docs/object-storage/objects/upload/help.md @@ -0,0 +1,29 @@ +# Upload a file to a bucket + +## Usage: +```bash +Usage: + ./mgc object-storage objects upload [src] [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects upload --dst="my-bucket/dir/file.txt" --src="./file.txt" --storage-class="cold" + +## Other commands: +- Flags: +- --dst uri Full destination path in the bucket with desired filename (required) +- -h, --help help for upload +- --src file Source file path to be uploaded (required) +- --storage-class enum Type of Storage in which to store object (one of "", "cold", "cold_instant", "glacier_ir" or "standard") (default "") + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/object-storage/objects/versions/help.md b/docs/object-storage/objects/versions/help.md new file mode 100644 index 0000000..d61ce3a --- /dev/null +++ b/docs/object-storage/objects/versions/help.md @@ -0,0 +1,27 @@ +# Retrieve all versions of an object + +## Usage: +```bash +Usage: + ./mgc object-storage objects versions [dst] [flags] +``` + +## Product catalog: +- Examples: +- ./mgc object-storage objects versions --dst="bucket1/file.txt" + +## Other commands: +- Flags: +- --dst uri Path of the object to retrieve versions from (required) +- -h, --help help for versions + +## Flags: +```bash +Global Flags: + --chunk-size integer Chunk size to consider when doing multipart requests. Specified in Mb (range: 8 - 5120) (default 8) + --cli.show-cli-globals Show all CLI global flags on usage text + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use + --workers integer Number of routines that spawn to do parallel operations within object_storage (min: 1) (default 5) +``` + diff --git a/docs/profile/create/help.md b/docs/profile/create/help.md new file mode 100644 index 0000000..be03f83 --- /dev/null +++ b/docs/profile/create/help.md @@ -0,0 +1,23 @@ +# Creates a new profile + +## Usage: +```bash +Usage: + ./mgc profile create [name] [copy] [flags] +``` + +## Product catalog: +- Flags: +- --copy string Name of the profile to copy content from. If this parameter is passed, the new Profile will be pre-populated with the contents of the Profile with the specified name +- -h, --help help for create +- --name string Profile name (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/profile/delete/help.md b/docs/profile/delete/help.md new file mode 100644 index 0000000..c8de7da --- /dev/null +++ b/docs/profile/delete/help.md @@ -0,0 +1,22 @@ +# Deletes the profile with the specified name + +## Usage: +```bash +Usage: + ./mgc profile delete [name] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for delete +- --name string Profile name (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/profile/get/help.md b/docs/profile/get/help.md new file mode 100644 index 0000000..27b5ac5 --- /dev/null +++ b/docs/profile/get/help.md @@ -0,0 +1,21 @@ +# Get current profile. + +## Usage: +```bash +Usage: + ./mgc profile get [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/profile/help.md b/docs/profile/help.md new file mode 100644 index 0000000..508a39f --- /dev/null +++ b/docs/profile/help.md @@ -0,0 +1,29 @@ +# Profiles hold auth and runtime configuration for the MgcSDK, like tokens and log filter settings. +Users can create as many profiles as they choose to. Auth and config operations will affect only the +current profile, so users can alter and switch between profiles without loosing the previous configuration + +## Usage: +```bash +Usage: + ./mgc profile [flags] + ./mgc profile [command] +``` + +## Product catalog: +- Commands: +- create Creates a new profile +- delete Deletes the profile with the specified name +- get Get current profile. +- list List all available profiles +- set Sets profile to be used + +## Other commands: +- Additional Commands: +- select call "list", prompt selection and then "set" + +## Flags: +```bash +Flags: + -h, --help help for profile +``` + diff --git a/docs/profile/list/help.md b/docs/profile/list/help.md new file mode 100644 index 0000000..74dc18b --- /dev/null +++ b/docs/profile/list/help.md @@ -0,0 +1,21 @@ +# List all available profiles + +## Usage: +```bash +Usage: + ./mgc profile list [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/profile/set/help.md b/docs/profile/set/help.md new file mode 100644 index 0000000..69e503e --- /dev/null +++ b/docs/profile/set/help.md @@ -0,0 +1,22 @@ +# Sets profile to be used + +## Usage: +```bash +Usage: + ./mgc profile set [name] [flags] +``` + +## Product catalog: +- Flags: +- -h, --help help for set +- --name string Profile name (required) + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/help.md b/docs/virtual-machine/help.md new file mode 100644 index 0000000..9e06d0e --- /dev/null +++ b/docs/virtual-machine/help.md @@ -0,0 +1,27 @@ +# Virtual Machine Api Product + +## Usage: +```bash +Usage: + ./mgc virtual-machine [flags] + ./mgc virtual-machine [command] +``` + +## Product catalog: +- Aliases: +- virtual-machine, vms, vm, virtual-machines, machines, vmachine + +## Other commands: +- Commands: +- images Operations with images for instances. +- instances Operations with instances, including create, delete, start, stop, reboot and other actions. +- machine-types Operations with machine types for instances. +- snapshots Operations with snapshots for instances. + +## Flags: +```bash +Flags: + -h, --help help for virtual-machine + -v, --version version for virtual-machine +``` + diff --git a/docs/virtual-machine/images/help.md b/docs/virtual-machine/images/help.md new file mode 100644 index 0000000..db4b45e --- /dev/null +++ b/docs/virtual-machine/images/help.md @@ -0,0 +1,24 @@ +# Operations with images for instances. + +## Usage: +```bash +Usage: + ./mgc virtual-machine images [flags] + ./mgc virtual-machine images [command] +``` + +## Product catalog: +- Commands: +- list Retrieves all images. + +## Other commands: +- Flags: +- -h, --help help for images +- -v, --version version for images + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/virtual-machine/images/list/help.md b/docs/virtual-machine/images/list/help.md new file mode 100644 index 0000000..c246593 --- /dev/null +++ b/docs/virtual-machine/images/list/help.md @@ -0,0 +1,28 @@ +# Retrieve a list of images allowed for the current region. + +## Usage: +```bash +Usage: + ./mgc virtual-machine images list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit (max: 2147483647) (default 50) +- --control.offset integer Offset (max: 2147483647) +- --control.sort string Sort (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "platform:asc,end_life_at:desc") +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/instances/create/help.md b/docs/virtual-machine/instances/create/help.md new file mode 100644 index 0000000..c7a5585 --- /dev/null +++ b/docs/virtual-machine/instances/create/help.md @@ -0,0 +1,63 @@ +# Create a Virtual Machine instance + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances create [flags] +``` + +## Product catalog: +- Examples: +- ./mgc virtual-machine instances create --image.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --image.name="some_resource_name" --machine-type.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --machine-type.name="some_resource_name" --network.associate-public-ip=true --network.interface.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --network.interface.security-groups='[{"id":"9ec75090-2872-4f51-8111-53d05d96d2c6"}]' --network.vpc.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --network.vpc.name="some_resource_name" + +## Other commands: +- Flags: +- --availability-zone string Availability Zone (between 1 and 255 characters) +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for create +- --image object Image (at least one of: single property: id or single property: name) +- Use --image=help for more details (required) +- --image.id string Image: Id (between 1 and 255 characters) +- This is the same as '--image=id:string'. +- --image.name string Image: Name (between 1 and 255 characters) +- This is the same as '--image=name:string'. +- --machine-type object Machine Type (at least one of: single property: id or single property: name) +- Use --machine-type=help for more details (required) +- --machine-type.id string Machine Type: Id (between 1 and 255 characters) +- This is the same as '--machine-type=id:string'. +- --machine-type.name string Machine Type: Name (between 1 and 255 characters) +- This is the same as '--machine-type=name:string'. +- --name string Name (between 1 and 255 characters) (required) +- --network object (properties: associate_public_ip, interface and vpc) +- Use --network=help for more details +- --network.associate-public-ip boolean network's associate_public_ip property: Associate Public Ip +- This is the same as '--network=associate_public_ip:boolean'. (default true) +- --network.interface object network's interface property: Interface (at least one of: single property: id or single property: security_groups) +- Use --network.interface=help for more details +- This is the same as '--network=interface:object'. +- --network.interface.id string Interface: Id (between 1 and 255 characters) +- This is the same as '--network.interface=id:string'. +- --network.interface.security-groups array Interface: Security Groups +- Use --network.interface.security-groups=help for more details +- This is the same as '--network.interface=security_groups:array'. (default []) +- --network.vpc object network's vpc property: Vpc (at least one of: single property: id or single property: name) +- Use --network.vpc=help for more details +- This is the same as '--network=vpc:object'. (default {"name":"default"}) +- --network.vpc.id string Vpc: Id (between 1 and 255 characters) +- This is the same as '--network.vpc=id:string'. +- --network.vpc.name string Vpc: Name (between 1 and 255 characters) +- This is the same as '--network.vpc=name:string'. +- --ssh-key-name string Ssh key Name (required) +- --user-data string Used to perform automated configuration tasks. (between 1 and 65000 characters) +- -v, --version version for create + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/delete/help.md b/docs/virtual-machine/instances/delete/help.md new file mode 100644 index 0000000..7fb1569 --- /dev/null +++ b/docs/virtual-machine/instances/delete/help.md @@ -0,0 +1,27 @@ +# Delete a Virtual Machine instance + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances delete [id] [flags] +``` + +## Product catalog: +- Flags: +- --delete-public-ip Delete Public Ip +- -h, --help help for delete +- --id uuid Id (required) +- -v, --version version for delete + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/instances/get/help.md b/docs/virtual-machine/instances/get/help.md new file mode 100644 index 0000000..cb56471 --- /dev/null +++ b/docs/virtual-machine/instances/get/help.md @@ -0,0 +1,28 @@ +# Get a Virtual Machine instance details + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances get [id] [flags] +``` + +## Product catalog: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --expand array(string) Expand: You can get more detailed info about: ['image', 'machine-type', 'network'] (default ["network","image","machine-type"]) +- -h, --help help for get +- --id string Id (required) +- -v, --version version for get + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/instances/help.md b/docs/virtual-machine/instances/help.md new file mode 100644 index 0000000..675ca8d --- /dev/null +++ b/docs/virtual-machine/instances/help.md @@ -0,0 +1,34 @@ +# Operations with instances, including create, delete, start, stop, reboot and other actions. + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances [flags] + ./mgc virtual-machine instances [command] +``` + +## Product catalog: +- Commands: +- create Create an instance. +- delete Delete an instance. +- get Retrieve the details of a specific instance. +- list List all instances. +- network-interface network-interface +- reboot Reboot an instance. +- rename Renames an instance. +- retype Changes an instance machine-type. +- start Starts an instance. +- stop Stops an instance. +- suspend Suspends instance. + +## Other commands: +- Flags: +- -h, --help help for instances +- -v, --version version for instances + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/virtual-machine/instances/list/help.md b/docs/virtual-machine/instances/list/help.md new file mode 100644 index 0000000..25c31e8 --- /dev/null +++ b/docs/virtual-machine/instances/list/help.md @@ -0,0 +1,29 @@ +# List Virtual Machine instances + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit: limit the number of the results (max: 2147483647) (default 50) +- --control.offset integer Offset: pagination for the results limited (max: 2147483647) +- --control.sort string Sort: order of the results using informed fields (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- --expand array(string) Expand: You can get more detailed info about: ['image', 'machine-type', 'network'] (default []) +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/instances/network-interface/attach/help.md b/docs/virtual-machine/instances/network-interface/attach/help.md new file mode 100644 index 0000000..c2c2afe --- /dev/null +++ b/docs/virtual-machine/instances/network-interface/attach/help.md @@ -0,0 +1,39 @@ +# Attach network interface to an instance for a default project. + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances network-interface attach [flags] +``` + +## Product catalog: +- Examples: +- ./mgc virtual-machine instances network-interface attach --instance.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --instance.name="some_resource_name" --network.interface.id="9ec75090-2872-4f51-8111-53d05d96d2c6" + +## Other commands: +- Flags: +- -h, --help help for attach +- --instance object Instance (at least one of: single property: id or single property: name) +- Use --instance=help for more details (required) +- --instance.id string Instance: Id (between 1 and 255 characters) +- This is the same as '--instance=id:string'. +- --instance.name string Instance: Name (between 1 and 255 characters) +- This is the same as '--instance=name:string'. +- --network object NICRequestInterfaceField (single property: interface) +- Use --network=help for more details (required) +- --network.interface object NICRequestInterfaceField: ID (single property: id) +- Use --network.interface=help for more details +- This is the same as '--network=interface:object'. +- --network.interface.id string ID: Id (between 1 and 255 characters) +- This is the same as '--network.interface=id:string'. +- -v, --version version for attach + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/network-interface/detach/help.md b/docs/virtual-machine/instances/network-interface/detach/help.md new file mode 100644 index 0000000..88026a1 --- /dev/null +++ b/docs/virtual-machine/instances/network-interface/detach/help.md @@ -0,0 +1,39 @@ +# Detach a non primary network interface from an instance for a default project + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances network-interface detach [flags] +``` + +## Product catalog: +- Examples: +- ./mgc virtual-machine instances network-interface detach --instance.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --instance.name="some_resource_name" --network.interface.id="9ec75090-2872-4f51-8111-53d05d96d2c6" + +## Other commands: +- Flags: +- -h, --help help for detach +- --instance object Instance (at least one of: single property: id or single property: name) +- Use --instance=help for more details (required) +- --instance.id string Instance: Id (between 1 and 255 characters) +- This is the same as '--instance=id:string'. +- --instance.name string Instance: Name (between 1 and 255 characters) +- This is the same as '--instance=name:string'. +- --network object NICRequestInterfaceField (single property: interface) +- Use --network=help for more details (required) +- --network.interface object NICRequestInterfaceField: ID (single property: id) +- Use --network.interface=help for more details +- This is the same as '--network=interface:object'. +- --network.interface.id string ID: Id (between 1 and 255 characters) +- This is the same as '--network.interface=id:string'. +- -v, --version version for detach + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/network-interface/help.md b/docs/virtual-machine/instances/network-interface/help.md new file mode 100644 index 0000000..833b1f1 --- /dev/null +++ b/docs/virtual-machine/instances/network-interface/help.md @@ -0,0 +1,25 @@ +# Operations with instances, including create, delete, start, stop, reboot and other actions. | network-interface + +## Usage: +```bash +Usage: + ./mgc virtual-machine instances network-interface [flags] + ./mgc virtual-machine instances network-interface [command] +``` + +## Product catalog: +- Commands: +- attach Attach network interface to an instance. +- detach Detach a non primary network interface from an instance. + +## Other commands: +- Flags: +- -h, --help help for network-interface +- -v, --version version for network-interface + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/virtual-machine/instances/reboot/help.md b/docs/virtual-machine/instances/reboot/help.md new file mode 100644 index 0000000..71bb82a --- /dev/null +++ b/docs/virtual-machine/instances/reboot/help.md @@ -0,0 +1,32 @@ +# Reboots a Virtual Machine instance with the id provided in the current tenant which is logged in. +#### Notes +- You can use the virtual-machine list command to retrieve all instances, so you can get the id +of the instance that you want to reboot. + +## Usage: +```bash +#### Rules +- The instance must be in the running or suspend state. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine instances reboot [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for reboot +- --id uuid Id (required) +- -v, --version version for reboot + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/rename/help.md b/docs/virtual-machine/instances/rename/help.md new file mode 100644 index 0000000..89e2ec0 --- /dev/null +++ b/docs/virtual-machine/instances/rename/help.md @@ -0,0 +1,31 @@ +# Renames a Virtual Machine instance with the id provided in the current tenant which is logged in. + +## Usage: +```bash +#### Notes +- You can use the virtual-machine list command to retrieve all instances, so you can get the id of +the instance that you want to rename. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine instances rename [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for rename +- --id string Id (required) +- --name string Name (between 1 and 255 characters) (required) +- -v, --version version for rename + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/retype/help.md b/docs/virtual-machine/instances/retype/help.md new file mode 100644 index 0000000..d1d7c0d --- /dev/null +++ b/docs/virtual-machine/instances/retype/help.md @@ -0,0 +1,28 @@ +# Changes a Virtual Machine instance machine type with the id provided in the current tenant +which is logged in. + +## Usage: +```bash +#### Notes +- You can use the virtual-machine list command to retrieve all instances, so you can get +the id of the instance that you want to change the machine type. +``` + +## Product catalog: +- #### Rules +- - The instance must be in the running or stopped state. +- - The new machine type must be compatible with the current machine type. +- - The new machine type must be available in the same region as the current machine type. +- - You must provide either the machine type id or the machine type name, if you provide both, +- the machine type id will be used. + +## Other commands: +- Usage: +- ./mgc virtual-machine instances retype [id] [flags] + +## Flags: +```bash +Examples: + ./mgc virtual-machine instances retype --machine-type.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --machine-type.name="some_resource_name" +``` + diff --git a/docs/virtual-machine/instances/start/help.md b/docs/virtual-machine/instances/start/help.md new file mode 100644 index 0000000..010d7eb --- /dev/null +++ b/docs/virtual-machine/instances/start/help.md @@ -0,0 +1,32 @@ +# Starts a Virtual Machine instance with the id provided in the current tenant which is logged in. +#### Notes +- You can use the virtual-machine list command to retrieve all instances, +so you can get the id of the instance that you want to start. + +## Usage: +```bash +#### Rules +- The instance must be in the stopped or suspended states. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine instances start [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for start +- --id uuid Id (required) +- -v, --version version for start + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/stop/help.md b/docs/virtual-machine/instances/stop/help.md new file mode 100644 index 0000000..b6608c9 --- /dev/null +++ b/docs/virtual-machine/instances/stop/help.md @@ -0,0 +1,32 @@ +# Stops a Virtual Machine instance with the id provided in the current tenant which is logged in. +#### Notes +- You can use the virtual-machine list command to retrieve all instances, so you can get the id of +the instance that you want to stop. + +## Usage: +```bash +#### Rules +- The instance must be in the running state. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine instances stop [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for stop +- --id uuid Id (required) +- -v, --version version for stop + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/instances/suspend/help.md b/docs/virtual-machine/instances/suspend/help.md new file mode 100644 index 0000000..e3659fa --- /dev/null +++ b/docs/virtual-machine/instances/suspend/help.md @@ -0,0 +1,27 @@ +# Suspends a Virtual Machine instance with the id provided in the current tenant which is logged in. + +## Usage: +```bash +#### Notes +- You can use the virtual-machine list command to retrieve all instances, so you can get the id of +the instance that you want to suspend. +``` + +## Product catalog: +- #### Rules +- - The instance must be in the running state. + +## Other commands: +- Usage: +- ./mgc virtual-machine instances suspend [id] [flags] + +## Flags: +```bash +Flags: + --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") + --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' + -h, --help help for suspend + --id uuid Id (required) + -v, --version version for suspend +``` + diff --git a/docs/virtual-machine/machine-types/help.md b/docs/virtual-machine/machine-types/help.md new file mode 100644 index 0000000..d402dba --- /dev/null +++ b/docs/virtual-machine/machine-types/help.md @@ -0,0 +1,24 @@ +# Operations with machine types for instances. + +## Usage: +```bash +Usage: + ./mgc virtual-machine machine-types [flags] + ./mgc virtual-machine machine-types [command] +``` + +## Product catalog: +- Commands: +- list Retrieves all machine-types. + +## Other commands: +- Flags: +- -h, --help help for machine-types +- -v, --version version for machine-types + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/virtual-machine/machine-types/list/help.md b/docs/virtual-machine/machine-types/list/help.md new file mode 100644 index 0000000..aa76250 --- /dev/null +++ b/docs/virtual-machine/machine-types/list/help.md @@ -0,0 +1,28 @@ +# Retrieves a list of machine types allowed for the current tenant which is logged in. + +## Usage: +```bash +Usage: + ./mgc virtual-machine machine-types list [flags] +``` + +## Product catalog: +- Flags: +- --control.limit integer Limit: limit the number of the results (max: 2147483647) (default 50) +- --control.offset integer Offset: pagination for the results limited (max: 2147483647) +- --control.sort string Sort: order of the results using informed fields (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- -h, --help help for list +- -v, --version version for list + +## Other commands: +- Global Flags: +- --cli.show-cli-globals Show all CLI global flags on usage text +- --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") +- --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") +- --server-url uri Manually specify the server to use + +## Flags: +```bash + +``` + diff --git a/docs/virtual-machine/snapshots/create/help.md b/docs/virtual-machine/snapshots/create/help.md new file mode 100644 index 0000000..edb7fda --- /dev/null +++ b/docs/virtual-machine/snapshots/create/help.md @@ -0,0 +1,26 @@ +# Create a snapshot of a Virtual Machine in the current tenant which is logged in.
+A Snapshot is ready for restore when it's in available state. + +## Usage: +```bash +#### Notes +- You can verify the state of snapshot using the snapshot get command, +- To create a snapshot it's mandatory inform a valid and unique name. +``` + +## Product catalog: +- #### Rules +- - It's only possible to create a snapshot of a valid virtual machine. +- - It's not possible to create 2 snapshots with the same name. +- - You can inform ID or Name from a Virtual Machine if both informed the priority will be ID. + +## Other commands: +- Usage: +- ./mgc virtual-machine snapshots create [flags] + +## Flags: +```bash +Examples: + ./mgc virtual-machine snapshots create --virtual-machine.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --virtual-machine.name="some_resource_name" +``` + diff --git a/docs/virtual-machine/snapshots/delete/help.md b/docs/virtual-machine/snapshots/delete/help.md new file mode 100644 index 0000000..23521c3 --- /dev/null +++ b/docs/virtual-machine/snapshots/delete/help.md @@ -0,0 +1,29 @@ +# Deletes an snapshot with the id provided in the current tenant +which is logged in. + +## Usage: +```bash +#### Notes +- You can use the Snapshots list command to retrieve all snapshots, so +- you can get the id of the snapshot that you want to delete. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine snapshots delete [id] [flags] + +## Other commands: +- Flags: +- -h, --help help for delete +- --id uuid Id (required) +- -v, --version version for delete + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/snapshots/get/help.md b/docs/virtual-machine/snapshots/get/help.md new file mode 100644 index 0000000..afc8064 --- /dev/null +++ b/docs/virtual-machine/snapshots/get/help.md @@ -0,0 +1,27 @@ +# Get an snapshot details for the current tenant which is logged in. + +## Usage: +```bash +#### Notes +- You can use the snapshots list command to retrieve all snapshots, +so you can get the id of the snapshot that you want to get details. +``` + +## Product catalog: +- - You can use the **expand** argument to get more details from the inner objects +- like image or type. + +## Other commands: +- Usage: +- ./mgc virtual-machine snapshots get [id] [flags] + +## Flags: +```bash +Flags: + --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") + --expand array(string) Expand: You can get more detailed info about: ['image', 'machine-type'] (default []) + -h, --help help for get + --id string Id (required) + -v, --version version for get +``` + diff --git a/docs/virtual-machine/snapshots/help.md b/docs/virtual-machine/snapshots/help.md new file mode 100644 index 0000000..9464d52 --- /dev/null +++ b/docs/virtual-machine/snapshots/help.md @@ -0,0 +1,29 @@ +# Operations with snapshots for instances. + +## Usage: +```bash +Usage: + ./mgc virtual-machine snapshots [flags] + ./mgc virtual-machine snapshots [command] +``` + +## Product catalog: +- Commands: +- create Create a snapshot of a virtual machine. +- delete Delete a Snapshot. +- get Retrieve the details of an snapshot. +- list Lists all snapshots in the current tenant. +- rename Renames a snapshot. +- restore Restore a snapshot to a virtual machine. + +## Other commands: +- Flags: +- -h, --help help for snapshots +- -v, --version version for snapshots + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text +``` + diff --git a/docs/virtual-machine/snapshots/list/help.md b/docs/virtual-machine/snapshots/list/help.md new file mode 100644 index 0000000..d4c08e9 --- /dev/null +++ b/docs/virtual-machine/snapshots/list/help.md @@ -0,0 +1,31 @@ +# List all snapshots in the current tenant which is logged in. + +## Usage: +```bash +#### Notes +- You can use the **expand** argument to get more details from the inner objects +like image and machine types. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine snapshots list [flags] + +## Other commands: +- Flags: +- --control.limit integer Limit: limit the number of the results (max: 2147483647) (default 50) +- --control.offset integer Offset: pagination for the results limited (max: 2147483647) +- --control.sort string Sort: order of the results using informed fields (pattern: ^(^[\w-]+:(asc|desc)(,[\w-]+:(asc|desc))*)?$) (default "created_at:asc") +- --expand array(string) Expand: You can get more detailed info about: ['image', 'machine-type'] (default []) +- -h, --help help for list +- -v, --version version for list + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/snapshots/rename/help.md b/docs/virtual-machine/snapshots/rename/help.md new file mode 100644 index 0000000..5cd7430 --- /dev/null +++ b/docs/virtual-machine/snapshots/rename/help.md @@ -0,0 +1,31 @@ +# Renames a Snapshot with the id provided in the current tenant which is logged in. + +## Usage: +```bash +#### Notes +- You can use the snapshots list command to retrieve all snapshots, so you can get the id of +the snapshot that you want to rename. +``` + +## Product catalog: +- Usage: +- ./mgc virtual-machine snapshots rename [id] [flags] + +## Other commands: +- Flags: +- --cli.list-links enum[=table] List all available links for this command (one of "json", "table" or "yaml") +- --cli.watch Wait until the operation is completed by calling the 'get' link and waiting until termination. Akin to '! get -w' +- -h, --help help for rename +- --id string Id (required) +- --name string Name (between 1 and 255 characters) (required) +- -v, --version version for rename + +## Flags: +```bash +Global Flags: + --cli.show-cli-globals Show all CLI global flags on usage text + --env enum Environment to use (one of "pre-prod" or "prod") (default "prod") + --region enum Region to reach the service (one of "br-mgl1", "br-ne1" or "br-se1") (default "br-se1") + --server-url uri Manually specify the server to use +``` + diff --git a/docs/virtual-machine/snapshots/restore/help.md b/docs/virtual-machine/snapshots/restore/help.md new file mode 100644 index 0000000..b668ecc --- /dev/null +++ b/docs/virtual-machine/snapshots/restore/help.md @@ -0,0 +1,26 @@ +# Restore a snapshot of a Virtual Machine with the current tenant which is logged in.
+A Snapshot is ready for restore when it's in available state. + +## Usage: +```bash +#### Notes +- You can verify the state of snapshot using the snapshot list command. +- Use machine-types list to see all machine types available. +``` + +## Product catalog: +- #### Rules +- - To restore a snapshot you have to inform the new virtual machine information. +- - You can choose a machine-type that has a disk equal or larger +- than the original virtual machine type. + +## Other commands: +- Usage: +- ./mgc virtual-machine snapshots restore [id] [flags] + +## Flags: +```bash +Examples: + ./mgc virtual-machine snapshots restore --machine-type.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --machine-type.name="some_resource_name" --network.associate-public-ip=true --network.interface.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --network.interface.security-groups='[{"id":"9ec75090-2872-4f51-8111-53d05d96d2c6"}]' --network.vpc.id="9ec75090-2872-4f51-8111-53d05d96d2c6" --network.vpc.name="some_resource_name" +``` +