Command Line Tool for Facets
Learn how to use facetsctl Command Line Tool
Facets Command Line Tool is an easier alternative to Facets APIs to push builds to Facets Control Plane.
NPM Page
You can view and download the latest facetsctl
package from its NPM page.
Commands
facetsctl
provides the following commands for users.
facetsctl help [COMMAND]
This command will display help for facetsctl
.
USAGE
$ facetsctl help [COMMAND] [-n]
ARGUMENTS
COMMAND
- Command to show help for.
DESCRIPTION
Display help for facetsctl.
FLAGS
Flag | Required | What does it do? |
---|---|---|
-n, --nested-commands | No | Defines if all nested commands should be included in the output. |
facetsctl login
This command will allow the user to login to Facets Control Plane.
USAGE
$ facetsctl login -u <value> -t <value> -c <value>
DESCRIPTION
Login to Facets control plane
FLAGS
Flag | Required | What does it do? |
---|---|---|
-c, --cp-url = <value> | Yes | Defines the URL of the Control plane |
-t, --access-token = <value> | Yes | Defines the personal token generated for the user |
-u, --username = <value> | Yes | Defines the username of the user |
facetsctl push
This command will let users push new docker artifacts to the Facets Control Plane.
USAGE
$ facetsctl push -i <value> -a <value> --registration-type CLUSTER|RELEASE_STREAM --registration-value
<value> -e <value> [-d <value>] [--artifactory <value>]
DESCRIPTION
Post new docker artifacts to the Facets control plane.
FLAGS
Flag | Required | What does it do? |
---|---|---|
-a, --artifact-name = <value> | Yes | Defines the name of the artifact as mentioned in blueprint |
-d, --description = <value> | No | Defines the description of the build, if any |
-e, --external-id = <value> | Yes | Defines the external identifier for the artifact |
-i, --docker-image = <value> | Yes | Defines the image location. Used as <IMAGE:TAG>. |
--artifactory = <value> | No | Defines the artifactory where the image will be pushed. |
--registration-type = <option> | Yes | Defines the mode of registration. Used as <options: CLUSTER|RELEASE_STREAM>. |
--registration-value = <value> | Yes | Defines the value for release stream or cluster id, based on mode of registration. |
facetsctl refresh
This command will refresh the Kubernetes credentials for the user in the specified environment.
USAGE
facetsctl refresh --cluster-id <value>
#or
facetsctl refresh --blueprint-name <value> --cluster-name <value>
DESCRIPTION
Refreshes the credentials for the user in the specified environment in the defined blueprint.
FLAGS
Flag | Required? | What does it do? |
---|---|---|
--cluster-id | Yes | Defines the unique id for the environment. |
--blueprint-name | Yes | Defines the unique name of the defined blueprint. |
--cluster-name | Yes | Defines the name of the environment in defined blueprint. |
Updated 6 months ago