To run SAT commands on the Kubernetes control plane (ncn-m
) nodes, first set up authentication to
the API gateway. For more information on which SAT commands require authentication to the API
Gateway, see SAT Command Overview.
For more general information on API gateway authentication, see System Security and Authentication.
The admin account used to authenticate with sat auth
must be enabled in
Keycloak and must have its assigned role set to admin. For more information
on Keycloak accounts and changing Role Mappings, refer to the following sections:
The sat auth
command prompts for a password for the configured username on
the command line. The username value is obtained from the following locations,
in order of higher precedence to lower precedence:
--username
global command-line option.username
option in the api_gateway
section of the configuration file
at ~/.config/sat/sat.toml
.sat
command.If credentials are entered correctly when prompted by sat auth
, a token file
will be obtained and saved to ~/.config/sat/tokens
. Subsequent sat commands
will determine the username the same way as sat auth
described above and will
use the token for that username if it has been obtained and saved by sat auth
.
The following procedure describes how to configure the username in the SAT configuration file and authenticate as that user to the API gateway.
(ncn-m001#
) Generate a default SAT configuration file if one does not exist.
sat init
Example output:
Configuration file "/root/.config/sat/sat.toml" generated.
Note: If the configuration file already exists, it will print out the following error.
ERROR: Configuration file "/root/.config/sat/sat.toml" already exists.
Not generating configuration file.
(ncn-m001#
) Edit ~/.config/sat/sat.toml
and set the username option in the api_gateway
section of the configuration file.
username = "crayadmin"
(ncn-m001#
) Run sat auth
. Enter the password when prompted.
sat auth
Example output:
Password for crayadmin:
Succeeded!
(ncn-m001#
) Other sat
commands are now authenticated to make requests to the API gateway.
sat status