Cloud and Organization Setup Commands

pyrrowhead cloud

$ pyrrowhead cloud --help
Usage: pyrrowhead cloud [OPTIONS] COMMAND [ARGS]...

  Used to set up, configure, start, and stop local clouds using the
  appropriate subcommand. See list below.

Options:
  --help  Show this message and exit.

Commands:
  client-add  Adds system to the cloud configuration.
  configure   Statically configures an existing local cloud.
  create      Sets up local clouds by creating a folder structure and...
  down        Shuts down local cloud.
  install     Installs cloud by creating certificate files and core...
  list        Lists all local clouds.
  uninstall   Uninstalls cloud by removing certificate files and core...
  up          Starts local cloud core system docker containers.

pyrrowhead cloud list

$ pyrrowhead cloud list --help
Usage: pyrrowhead cloud list [OPTIONS]

  Lists all local clouds.

Options:
  --help  Show this message and exit.

pyrrowhead cloud create

$ pyrrowhead cloud create --help
Usage: pyrrowhead cloud create [OPTIONS] [CLOUD_IDENTIFIER]

  Sets up local clouds by creating a folder structure and cloud_config.yaml
  file.

  CLOUD_NAME and ORG_name are the cloud and organization names used in the
  generated certificates.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT                CLOUD_NAME. Mandatory with option -o and
                                  mutually exclusive with argument
                                  CLOUD_IDENTIFIER
  -o, --org TEXT                  ORG_NAME. Mandatory with option -c and
                                  mutually exclusive with argument
                                  CLOUD_IDENTIFIER
  -d, --dir PATH                  Directory of local cloud. Experimental
                                  feature. Should only be used when a local
                                  cloud is installed outside the default path.
  --ip-network IP                 IP network the docker network uses to run
                                  the local clouds  [default: 172.16.1.0/24]
  --san SUBJECT_ALTERNATIVE_NAME  Subject alternative names to include in the
                                  core system certificates. An example is the
                                  IP-address of the device the core systems
                                  are running on. IPs should be prefixed with
                                  'ip:' and DNS strings prefixed with 'dns:',
                                  for example ip:127.0.0.1 and
                                  dns:host123.example-org.com
  --ssl-enabled / --ssl-disabled  Enabled/disable local cloud security.
                                  Enabled by default. SSL rarely be disabled.
  --install                       Install local cloud after running the setup
                                  command.
  --include [intercloud|eventhandler|onboarding]
                                  Core systems to include apart from the
                                  mandatory core systems. --include
                                  eventhandler includes the eventhandler.
                                  --include intercloud includes the gateway
                                  and gatekeeper. --include onboarding
                                  includes the system and device registry,
                                  certificate authority and onboarding
                                  systems.
  --help                          Show this message and exit.

pyrrowhead cloud install

$ pyrrowhead cloud install --help
Usage: pyrrowhead cloud install [OPTIONS] [CLOUD_IDENTIFIER]

  Installs cloud by creating certificate files and core service configuration
  files.

  CLOUD_NAME and ORG_name are the cloud and organization names used in the
  generated certificates.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT  CLOUD_NAME. Mandatory with option -o and mutually
                    exclusive with argument CLOUD_IDENTIFIER
  -o, --org TEXT    ORG_NAME. Mandatory with option -c and mutually exclusive
                    with argument CLOUD_IDENTIFIER
  -d, --dir PATH    Directory of local cloud. Experimental feature. Should
                    only be used when a local cloud is installed outside the
                    default path.
  --help            Show this message and exit.

pyrrowhead cloud uninstall

$ pyrrowhead cloud uninstall --help
Usage: pyrrowhead cloud uninstall [OPTIONS] [CLOUD_IDENTIFIER]

  Uninstalls cloud by removing certificate files and core service
  configuration files. Keeps the cloud_config.yaml file by default.

  CLOUD_NAME and ORG_name are the cloud and organization names used in the
  generated certificates.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT  CLOUD_NAME. Mandatory with option -o and mutually
                    exclusive with argument CLOUD_IDENTIFIER
  -o, --org TEXT    ORG_NAME. Mandatory with option -c and mutually exclusive
                    with argument CLOUD_IDENTIFIER
  -d, --dir PATH    Directory of local cloud. Experimental feature. Should
                    only be used when a local cloud is installed outside the
                    default path.
  --complete        Completely removes all files, including cloud_config.yaml
  --help            Show this message and exit.

pyrrowhead cloud configure

$ pyrrowhead cloud configure --help
Usage: pyrrowhead cloud configure [OPTIONS] [CLOUD_IDENTIFIER]

  Statically configures an existing local cloud.

  The local cloud needs to be reinstalled after being configured to make sure
  the changes are applied.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT              CLOUD_NAME. Mandatory with option -o and
                                mutually exclusive with argument
                                CLOUD_IDENTIFIER
  -o, --org TEXT                ORG_NAME. Mandatory with option -c and
                                mutually exclusive with argument
                                CLOUD_IDENTIFIER
  -d, --dir PATH                Directory of local cloud. Experimental
                                feature. Should only be used when a local
                                cloud is installed outside the default path.
  --enable-ssl / --disable-ssl
  --help                        Show this message and exit.

pyrrowhead cloud client-add

$ pyrrowhead cloud client-add --help
Usage: pyrrowhead cloud client-add [OPTIONS] [CLOUD_IDENTIFIER]

  Adds system to the cloud configuration.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT        CLOUD_NAME. Mandatory with option -o and mutually
                          exclusive with argument CLOUD_IDENTIFIER
  -o, --org TEXT          ORG_NAME. Mandatory with option -c and mutually
                          exclusive with argument CLOUD_IDENTIFIER
  -d, --dir PATH          Directory of local cloud. Experimental feature.
                          Should only be used when a local cloud is installed
                          outside the default path.
  -n, --name SYSTEM_NAME  System name  [required]
  -a, --addr ADDRESS      System address
  -p, --port PORT         System port
  -s, --san SAN           Client subject alternative name.
  --help                  Show this message and exit.

pyrrowhead cloud up

$ pyrrowhead cloud up --help
Usage: pyrrowhead cloud up [OPTIONS] [CLOUD_IDENTIFIER]

  Starts local cloud core system docker containers.

  If this command fails during the mysql startup, it might be because you are
  running another mysql instance on port 3306. You must either terminate that
  service (e.g. running `systemctl stop mysql.service`) or change the port of
  mysql in the configuration and reinstall the local cloud before starting it
  again.

  This command might take a while if this is the first time starting a local
  cloud on this machine as docker needs to pull the images.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT        CLOUD_NAME. Mandatory with option -o and mutually
                          exclusive with argument CLOUD_IDENTIFIER
  -o, --org TEXT          ORG_NAME. Mandatory with option -c and mutually
                          exclusive with argument CLOUD_IDENTIFIER
  -d, --dir PATH          Directory of local cloud. Experimental feature.
                          Should only be used when a local cloud is installed
                          outside the default path.
   / -N, --no-set-active  Does not set this cloud as the active cloud, useful
                          if you want to start another cloud in the
                          background.
  --help                  Show this message and exit.

pyrrowhead cloud down

$ pyrrowhead cloud down --help
Usage: pyrrowhead cloud down [OPTIONS] [CLOUD_IDENTIFIER]

  Shuts down local cloud.

Arguments:
  [CLOUD_IDENTIFIER]  Cloud identifier string of format
                      <CLOUD_NAME>.<ORG_NAME>. Mutually exclusive with options
                      -c and -o.

Options:
  -c, --cloud TEXT  CLOUD_NAME. Mandatory with option -o and mutually
                    exclusive with argument CLOUD_IDENTIFIER
  -o, --org TEXT    ORG_NAME. Mandatory with option -c and mutually exclusive
                    with argument CLOUD_IDENTIFIER
  -d, --dir PATH    Directory of local cloud. Experimental feature. Should
                    only be used when a local cloud is installed outside the
                    default path.
  --help            Show this message and exit.