Guides
Start typing to search…

Facets CLI [no future support]

Learn how to use facetsctl Command Line Tool

Note: Please note that this version will no longer be supported. We recommend upgrading to the latest version of Facets CTL. Refer to the latest version of the Facets CLI documentation.

This documentation provides a quick reference guide for using the facetsctl CLI tool. It's an easy-to-use alternative to Facets APIs that allows users to push new docker artifacts to the Facets Control Plane and refresh Kubernetes credentials for the user in a specified environment.

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

This command displays the help for facetsctl. You can use it to get information about a specific command by providing the command name as an argument.

ARGUMENTS
COMMAND: Command to show help for.

FLAGS

FlagRequiredWhat does it do?
-n, --nested-commandsNoDefines if all nested commands should be included in the output.

facetsctl login

This command allows the user to log in to the Facets Control Plane.

$ facetsctl login -u <value> -t <value> -c <value>

FLAGS

FlagRequiredWhat does it do?
-c, --cp-url = <value>YesDefines the URL of the Control plane
-t, --access-token = <value>YesDefines the personal token generated for the user
-u, --username = <value>YesDefines the username of the user

facetsctl register

Register docker images from an external repository into the Facets Control Plane.

$ facetsctl register -i <value> -s <value> -e <value> --git-ref <value> [-d <value>]
[--registry <value>] [--registration-type CLUSTER|RELEASE_STREAM] 
[--blueprint-name <value>] [--debug <value>]

FLAGS

Flag

Required

What does it do?

-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 docker image URL in the external registry.

-s, --service=<value>

Yes

Defines the name of the CI Integration for which the artifact needs to be registered.

--blueprint-name=<value>

No

Defines the Blueprint name in which the CI Integration will be created if not present already.

--git-ref=<value>

Yes

Defines the git ref provided in CI Rule.

--registration-type=<option>

No

Defines the mode of registration for CI integration.
Used as <options: ENVIRONMENT | RELEASE_STREAM>

--registry=<value>

No

Defines the artifactory where the image will be pushed.

--debug=<value>

No

Defines if you want to view the original error message thrown.
[default: false]

facetsctl register by env

Register already pushed images from the external repository to the Facets Control Plane using the environment name.

  $ facetsctl register-by-env -i <value> -s <value> -e <value> --environment-name <value>
  --blueprint-name <value> [-d <value>] [--registry <value>] [--debug <value>]

FLAGS

FlagRequiredWhat does it do?
-d, --description=<value>NoDefines the description of the build if any.
-e, --external-id=<value>YesDefines the external identifier for the artifact.
-i, --docker-image=<value>YesDefines the docker image URL in the external registry.
-s, --service=<value>YesDefines the name of the CI integration for which the artifact needs to be registered.
--blueprint-name=<value>YesDefines the Blueprint name in which the given environment is present.
--debug=<value>NoDefines if you want to view the original error message thrown. [default: false]
--environment-name=<value>YesDefines the environment name in which the artifact will be registered.
--registry=<value>NoDefines the artifactory where the images will be pushed.

facetsctl register by releasestream

Register already pushed images from the external repository to the Facets control plane through the release stream.

$ facetsctl register-by-releasestream -i <value> -s <value> -e <value> --release-stream <value> 
[-d <value>] [--registry <value>] [--blueprint-name <value>] [--debug <value>]
FlagRequiredWhat does it do?
-d, --description=<value>NoDefines the description of the build if any.
-e, --external-id=<value>YesDefines the external identifier for the artifact.
-i, --docker-image=<value>YesDefines the docker image URL in the external registry.
-s, --service=<value>YesDefines the name of the CI integration for which the artifact needs to be registered.
--blueprint-name=<value>YesDefines the Blueprint name in which the given environment is present.
--debug=<value>NoDefines if you want to view the original error message thrown. [default: false]
--release-stream=<value>YesDefines the git ref provided in CI Rule.
--registry=<value>NoDefines the artifactory where the images will be pushed.

facetsctl push

The following command enables users to push new docker artifacts to specific release streams or environments in the Facets Control Plane:

$ facetsctl push -i <value> -a <value> --registration-type CLUSTER|RELEASE_STREAM --registration-value  
    <value> -e <value> [-d <value>] [--artifactory <value>]

The following command can be used to push an image to Facets and leverage the benefits of CI Rules for automatic classification:

$ facetsctl push --ci <ci_integration_name> --image <docker_image_name> --git-ref
  <git reference> -e <external_id_here> -d <your_build_description> --artifactory default

FLAGS

Flag

Required

What does it do?

-a, --artifact-name = <value>

Yes

Defines the name of the artifact as mentioned in the 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.

facetsctl refresh -e <value> 
#or 
facetsctl refresh --blueprint-name <value> --environment-name <value>

FLAGS

FlagRequired?What does it do?
-e, --environment-idYesDefines the unique ID for the environment.
--blueprint-nameYesDefines the unique name of the defined blueprint.
--environment-nameYesDefines the name of the environment in the defined blueprint.

facetsctl download-kubeconfig

This command can be used to download kubeconfig files for an Environment. You can either download it using the environment ID or retrieve it by specifying the blueprint name and environment name.

$ facetsctl download-kubeconfig -e <value>
#or
$ facetsctl download-kubeconfig --environment-name <value>  --blueprint-name ‹value>

FLAGS

FlagRequiredWhat does it do?
-e, --environment-idYesDefines the Environment ID for downloading kubeconfig.
--environment-nameYesDefines the Environment name for downloading kubeconfig.
--blueprint-nameYesDefines the Blueprint name using which environment was launched.

facetsctl upload

This command can be used to upload any type of application build file to the Facets Control Plane.

  $ facetsctl upload -p <value> -a <value> -e <value> [--registration-type ENVIRONMENT|RELEASE_STREAM] [--registration-value <value>] [--git-ref <value>] [--blueprint-name <value>] [-d  
    <value>] [--debug <value>]

FLAGS

Flag

Required

What does it do?

-a, --artifact-name=<value>

Yes

Defines the name of the artifact-ci as mentioned in resource spec.
If the CI integration is already created, provide its name. If not, additionally provide the Blueprint name and the registration type using respective flags.

-d, --description=<value>

No

Defines the description of the build if any.

-e, --external-id=<value>

Yes

Defines the external identifier for CI Integration.

-p, --file-path=<value>

Yes

Defines the path to the application build file (e.g., WAR, JAR, ZIP) on your local system.

--blueprint-name=<value>

No

Defines the name of the blueprint where the CI integration will be created.

--debug=<value>

No

See original error message thrown [default: false]

--git-ref=<value>

No

Defines the Git ref provided in CI Rule.

--registration-type=<option>

No

Defines the mode of registration.
Used as <options: ENVIRONMENT|RELEASE_STREAM>

--registration-value=<value>

No

Defines the value for the release stream or cluster ID based on the Registration mode.

Facets CLI version v1.0.9

For Mac Os

TypeArchitectureDownload link
Gzip64-bitfacetsctl-darwin-x64.tar.gz
XZ64-bitfacetsctl-darwin-x64.tar.xz
GzipARM64facetscti-darwin-arm64.tar.gz
XZARM64facetsctI-darwin-arm64.tar.xz

For Linux

TypeArchitectureDownload link
Gzip64-bitfacetsctl-linux-x64.tar.gz
XZ64-bitfacetsctI-linux-×64.tar.xz
GzipARMfacetsctl-linux-arm.tar.gz
XZARMfacetscti-linux-arm.tar.xz

For Windows

TypeArchitectureDownload link
Gzip64-bitfacetsctl-win32-x64.tar.gz
XZ64-bitfacetsctl-win32-x64.tar.xz
Gzip32-bitfacetsctI-win32-x86.tar.gz
XZ32-bitfacetsctI-win32-x86.tar.xz

Updated about 1 month ago