Bootstrap command options

The cephadm bootstrap command bootstraps an IBM Storage Ceph cluster on the local host. It deploys a MON daemon and a MGR daemon on the bootstrap node, automatically deploys the monitoring stack on the local host, and calls ceph orch host add HOSTNAME.

The following tables describe the different options when using the cephadm bootstrap command.
  • Table 1 lists the basic available options for cephadm bootstrap.
  • Table 2 lists the available options that are required to enable IBM Call Home by using the bootstrap command.
  • Table 3 lists the available options that are required to enable IBM Storage Insights by using the bootstrap command.
Table 1. General cephadm bootstrap command options
cephadm bootstrap option Description
--config CONFIG_FILE, -c CONFIG_FILE

CONFIG_FILE is the ceph.conf file to use with the bootstrap command
--cluster-network NETWORK_CIDR

Use the subnet defined by NETWORK_CIDR for internal cluster traffic. This is specified in CIDR notation. For example: 10.10.128.0/24.
--mon-id MON_ID

Bootstraps on the host named MON_ID. Default value is the local host.
--mon-addrv MON_ADDRV

mon IPs (e.g., [v2:localipaddr:3300,v1:localipaddr:6789])
--mon-ip IP_ADDRESS

IP address of the node you are using to run cephadm bootstrap.
--mgr-id MGR_ID

Host ID where a MGR node should be installed. Default: randomly generated.
--fsid FSID

Cluster FSID.
--output-dir OUTPUT_DIR

Use this directory to write config, keyring, and pub key files.
--output-keyring OUTPUT_KEYRING

Use this location to write the keyring file with the new cluster admin and mon keys.
--output-config OUTPUT_CONFIG

Use this location to write the configuration file to connect to the new cluster.
--output-pub-ssh-key OUTPUT_PUB_SSH_KEY

Use this location to write the public SSH key for the cluster.
--skip-ssh

Skip the setup of the ssh key on the local host.
--initial-dashboard-user INITIAL_DASHBOARD_USER

Initial user for the dashboard.
--initial-dashboard-password INITIAL_DASHBOARD_PASSWORD

Initial password for the initial dashboard user.
--ssl-dashboard-port SSL_DASHBOARD_PORT

Port number used to connect with the dashboard using SSL.
--dashboard-key DASHBOARD_KEY

Dashboard key.
--dashboard-crt DASHBOARD_CRT

Dashboard certificate.
--ssh-config SSH_CONFIG

SSH config.
--ssh-private-key SSH_PRIVATE_KEY

SSH private key.
--ssh-public-key SSH_PUBLIC_KEY

SSH public key.
--ssh-user SSH_USER

Sets the user for SSH connections to cluster hosts. Passwordless sudo is needed for non-root users.
--skip-mon-network

Sets mon public_network based on the bootstrap mon ip.
--skip-dashboard

Do not enable the Ceph Dashboard.
--dashboard-password-noupdate

Disable forced dashboard password change.
--no-minimize-config

Do not assimilate and minimize the configuration file.
--skip-ping-check

Do not verify that the mon IP is pingable.
--skip-pull

Do not pull the latest image before bootstrapping.
--skip-firewalld

Do not configure firewalld.
--allow-overwrite

Allow the overwrite of existing –output-* config/keyring/ssh files.
--allow-fqdn-hostname

Allow fully qualified host name.
--skip-prepare-host

Do not prepare host.
--orphan-initial-daemons

Do not create initial mon, mgr, and crash service specs.
--skip-monitoring-stack

Do not automatically provision the monitoring stack] (prometheus, grafana, alertmanager, node-exporter).
--apply-spec APPLY_SPEC

Apply cluster spec file after bootstrap (copy ssh key, add hosts and apply services).
--registry-url REGISTRY_URL

Specifies the URL of the custom registry to log into. For example: cp.icr.io/cp.
--registry-username REGISTRY_USERNAME

User name of the login account to the custom registry.
--registry-password REGISTRY_PASSWORD

Password of the login account to the custom registry.
--registry-json REGISTRY_JSON

JSON file containing registry login information.
Table 2. cephadm bootstrap command options for enabling IBM Call Home
cephadm bootstrap option Description
--enable-ibm-call-home Flag to opt-in to IBM Call Home. 
cephadm -v bootstrap --mon-ip 10.0.210.25 --registry-json registry.json --enable-ibm-call-home --call-home-config call_home.json
--call-home-icn IBM Customer Number (7 alphanumeric characters long).
--ceph-call-home-contact-first-name Storage help desk contact first name.
--ceph-call-home-contact-last-name Storage help desk contact last name.
--ceph-call-home-contact-email Storage help desk email. For example, storage_helpdesk@ibm.com.
--ceph-call-home-contact-phone Storage help desk phone number.
--ceph-call-home-country-code 2-letter country code.
--call-home-config File path to a JSON config file which includes the following keys: 
{ 
"icn": "<IBM_CUSTOMER_NUMBER>", 
"email": "<CALL_HOME_CONTACT_EMAIL_ADDRESS>", 
"phone": "<CALL_HOME_CONTACT_PHONE_NUMBER>", 
"first_name": "<CALL_HOME_CONTACT_FIRST_NAME>", 
"last_name": "<CALL_HOME_CONTACT_LAST_NAME>", 
"country_code": "<CUSTOMER_COUNTRY_CODE>" }
Use either the direct parameters with their options, or the --call-home-config flag with the file path.
Table 3. cephadm bootstrap command options for enabling IBM Storage Insights
cephadm bootstrap option Description
--enable-storage-insights Flag to opt-in to IBM Storage Insights.

Syntax:

cephadm -v bootstrap --mon-ip 10.0.210.25 --registry-json registry.json --enable-ibm-call-home --call-home-config call_home.json --enable-storage-insights --storage-insights-config si_opt.json
--storage-insights-tenant-id A Storage Insights tenant ID to be associated with this deployment.
--storage-insights-config File path to a JSON config file which includes the following key: 
{"tenant_id": "<STORAGE_INSIGHTS_TENANT_ID>"}
Use either the direct parameters with their options, or the --storage-insights-config flag and specify its file path.

Reference

  • For more information about the --skip-monitoring-stack option, see Adding hosts.
  • For more information about logging into the registry with the registry-json option, see help for the registry-login command.
  • For more information about cephadm options, see help for cephadm.