oatcli is a CLI tool for managing OAT resources.
Syntax description:
$ oatcli [OPTIONS] COMMAND [ARGS]...
Option description:
--install-completion: enables command completion for the current shell. However, command completion is unavailable for now.--show-completion: displays the command completion script for the current shell so that it can be copied or custom installed.--help: displays this message and exits.
Command description:
config: configures OAT API server address, username, etc.create: creates resources in OAT.dagrun: operates dagrun and displays task status in OAT.delete: deletes resources from OAT.describe: obtains detailed information about a resource in OAT.get: obtains information about a resource in OAT.
oatcli config
This command configures the OAT API server address, username, and password.
Syntax description:
$ oatcli config [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
get: obtains the configuration of the request to OAT API.set: sets the OAT API address, username, and password.
oatcli config get
This command obtains the configuration of the request to OAT API.
Syntax description:
$ oatcli config get [OPTIONS]
Option description:
--help: displays this message and exits.
oatcli config set
This command sets the OAT API address, username, and password.
Syntax description:
$ oatcli config set [OPTIONS]
Option description:
-s, --api-server TEXT: the IP address of the API server. Example: 127.0.0.1:7000.-u, --username TEXT: the username.-p, --password TEXT: the password.--help: displays this message and exits.
oatcli create
This command creates resources in OAT.
Syntax description:
$ oatcli create [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
component: creates a new component by using the configuration file.credential: adds SSH credentials for connecting to the server.idc: adds IDC information for the server.image: adds a component or product image. You can scan a local image or manually add image information.product: creates a new product by using the configuration file.server: adds and initializes a new server.
oatcli create component
This command creates a new component by using the configuration file.
Syntax description:
$ oatcli create component [OPTIONS]
Option description:
-t, --type [metadb]: the component type. At present, only metadb is supported. This option is required.-f, --file PATH: creates a component by using the configuration file.--help: displays this message and exits.
oatcli create credential
This command adds SSH credentials for connecting to the server.
Syntax description:
$ oatcli create credential [OPTIONS] NAME AUTH_TYPE:{password|pubkey|external}
Parameter description:
NAME: the name of the credentials. This parameter is required.AUTH_TYPE: the authentication type. Valid values: password, pubkey, and external.This parameter is required.
Option description:
-u, --username TEXT: the username. Default value: root.-p, --password TEXT: the password.-k, --key-file PATH: the SSH private key file.--help: displays this message and exits.
oatcli create idc
This command adds IDC information for the server.
Syntax description:
$ oatcli create idc [OPTIONS] NAME REGION
Parameter description:
NAME: the name of the IDC. This parameter is required.REGION: the region where the IDC resides. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli create image
This command adds a component or product image. You can scan a local image or manually add image information.
Syntax description:
$ oatcli create image [OPTIONS]
Option description:
-n, --name TEXT: the name of the remote image.-r, --repo-tag TEXT: the repo and tag of the remote image repository.-a, --arch [x86_64|aarch64]: the architecture of the remote image.--scan / --no-scan: specifies whether to scan a local image. Default value: no-scan.--help: displays this message and exits.
oatcli create product
This command creates a new product by using the configuration file.
Syntax description:
$ oatcli create product [OPTIONS]
Option description:
-t, --type [ocp]: the product type. At present, only OCP is supported. This option is required.-f, --file PATH: creates a product by using the configuration file.--help: displays this message and exits.
oatcli create server
This command adds and initializes a new server.
Syntax description:
$ oatcli create server [OPTIONS] IPS... INIT_TAG:{observer|obproduct|both}
Parameter description:
IPS...: the IP address of the server. This parameter is required.INIT_TAG:{observer|obproduct|both}: This parameter is required.
Option description:
-i, --idc TEXT: the name and region of the IDC, which must exist. This option is required.-c, --credential-name TEXT: the name of the credentials, which must exist. This option is required.--add-only / --no-add-only: specifies whether to add a server without configuring the operating system. Default value: no-add-only.--ssh-port INTEGER: the port used to establish an SSH connection. Default value: 22.--docker-root-dir TEXT: the root directory of Docker. Default value: /docker.--admin-uid-gid TEXT: the UID and GID of the admin user. Default value: 500:500.--admin-password TEXT: the password of the admin user.--help: displays this message and exits.
oatcli dagrun
This command operates dagrun and displays task status in OAT.
Syntax description:
$ oatcli dagrun [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
retry: retries failed tasks in dagrun.rollback: terminates and rolls back dagrun.skip: skips failed tasks in dagrun.
oatcli dagrun retry
This command retries failed tasks in dagrun.
Syntax description:
$ oatcli dagrun retry [OPTIONS] DAGRUN_ID [TASK_ID]
Parameter description:
DAGRUN_ID: the dagrun ID. This parameter is required.[TASK_ID]: the ID of a task. If this parameter is not specified, all failed tasks are retried.
Option description:
--help: displays this message and exits.
oatcli dagrun rollback
This command terminates and rolls back dagrun.
Syntax description:
$ oatcli dagrun rollback [OPTIONS] DAGRUN_ID
Parameter description:
DAGRUN_ID: the dagrun ID. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli dagrun skip
This command skips failed tasks in dagrun.
Syntax description:
$ oatcli dagrun skip [OPTIONS] DAGRUN_ID [TASK_ID]
Parameter description:
DAGRUN_ID: the dagrun ID. This parameter is required.[TASK_ID]: the ID of a task.
Option description:
--help: displays this message and exits.
oatcli delete
This command deletes resources from OAT.
Syntax description:
$ oatcli delete [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
component: deletes a component.credential: deletes credentials.image: deletes an image.product: deletes a product.server: deletes a server.
oatcli delete component
This command deletes a component.
Syntax description:
$ oatcli delete component [OPTIONS] NAME
Parameter description:
NAME: the name of the component. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli delete credential
Syntax description:
$ oatcli delete credential [OPTIONS] NAME
Parameter description:
NAME: the name of the credentials. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli delete image
This command deletes an image.
Syntax description:
$ oatcli delete image [OPTIONS] NAME
Parameter description:
NAME: the name of the image. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli delete product
This command deletes a product.
Syntax description:
$ oatcli delete product [OPTIONS] NAME
Parameter description:
NAME: the name of the product. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli delete server
This command deletes a server.
Syntax description:
$ oatcli delete server [OPTIONS] IP
Parameter description:
IP: the IP address of the server. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli describe
This command obtains resource details from OAT.
Syntax description:
$ oatcli describe [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
component: obtains detailed information about a component and related information about the dagrun.product: obtains detailed information about a product and related information about the dagrun.server: obtains detailed information about a server and related information about the dagrun.
oatcli describe component
This command obtains detailed information about a component and related information about the dagrun.
Syntax description:
$ oatcli describe component [OPTIONS] NAME
Parameters description:
NAME: the name of the component. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli describe product
This command obtains detailed information about a product and related information about the dagrun.
Syntax description:
$ oatcli describe product [OPTIONS] NAME
Parameter description:
NAME: the name of the product. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli describe server
This command obtains detailed information about a server and related information about the dagrun.
Syntax description:
$ oatcli describe server [OPTIONS] IP
Parameter description:
IP: the IP address of the server. This parameter is required.
Option description:
--help: displays this message and exits.
oatcli get
This command obtains resource information from OAT.
Syntax description:
$ oatcli get [OPTIONS] COMMAND [ARGS]...
Option description:
--help: displays this message and exits.
Command description:
component: obtains information about a component.credential: obtains information about credentials.idc: obtains information about an IDC.image: obtains information about an image.product: obtains information about a product.server: obtains information about a server.
oatcli get component
This command obtains information about a component.
Syntax description:
$ oatcli get component [OPTIONS] [NAME]
Parameter description:
[NAME]: the name of the component.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.
oatcli get credential
This command obtains information about credentials.
Syntax description:
$ oatcli get credential [OPTIONS] [NAME]
Parameter description:
[NAME]: the name of the credentials.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.
oatcli get idc
This command obtains information about an IDC.
Syntax description:
$ oatcli get idc [OPTIONS] [NAME]
Parameter description:
[NAME]: the name of the IDC.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.
oatcli get image
This command obtains information about an image.
Syntax description:
$ oatcli get image [OPTIONS] [NAME]
Parameter description:
[NAME]: the name of the image.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.
oatcli get product
This command obtains information about a product.
Syntax description:
$ oatcli get product [OPTIONS] [NAME]
Parameter description:
[NAME]: the name of the product.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.
oatcli get server
This command obtains information about a server.
Syntax description:
$ oatcli get server [OPTIONS] [IP]
Parameter description:
[IP]: the IP address of the server.
Option description:
-q, --query-params TEXT: general query parameters in the JavaScript Object Notation (JSON) format.--help: displays this message and exits.