CDF Manual Installer Script install Command Line Arguments

Argument

Description

--auto-configure-firewall

Flag to indicate whether to auto configure the firewall rules during node deployment. The allowable values are true or false. The default is true.

--cluster-name

Specifies the logical name of the cluster.

--deployment-log-location

Specifies the absolute path of the folder for placing the log files from deployments.

--docker-http-proxy

Proxy settings for Docker. Specify if accessing the Docker hub or Docker registry requires a proxy. By default, the value will be configured from the http_proxy environment variable on your system.

--docker-https-proxy

 

Proxy settings for Docker. Specify if accessing the Docker hub or Docker registry requires a proxy. By default, the value will be configured from https_proxy environment variable on your system

--docker-no-proxy

Specifies the IPv4 addresses or FQDs that do not require proxy settings for Docker. By default, the value will be configured from the no_proxy environment variable on your system.

--enable_fips

This parameter enables suites to enable and disable FIPS. The expected values are true or false. The default is false.

--fail-swap-on

 

If ‘swapping’ is enabled, specifies whether to make the kubelet fail to start. Set to true or false. The default is true.

--flannel-backend-type

 

Specifies flannel backend type. Supported values are vxlan and host-gw. The default is host-gw.

Note: The arcsight-install tool has two prechecks that will validate if Layer 2 connectivity is present between nodes. If not, the tool will recommend to use vxlan for flannel back end type.

--ha-virtual-ip

A Virtual IP (VIP) is an IP address that is shared by all master nodes. The VIP is used for the connection redundancy by providing failover for one machine. Should a master node fail, another master node takes over the VIP address and responds to requests sent to the VIP. Mandatory for a Multi-Master cluster; not applicable to a single-master cluster

The VIP must be resolved (forward and reverse) to the VIP Fully Qualified Domain Name (FQDN)

--k8s-home

 

Specifies the absolute path of the directory for the installation binaries. By default, the Kubernetes installation directory is /opt/arcsight/kubernetes.

--keepalived-nopreempt

Specifies whether to enable nopreempt mode for KeepAlived. The allowable value of this parameter is true or false. The default is true and KeepAlived is started in nopreempt mode.

--keepalived-virtual-router-id

 

Specifies the virtual router ID for KEEPALIVED. This virtual router ID is unique for each cluster under the same network segment. All nodes in the same cluster should use the same value, between 0 and 255. The default is 51.

--kube-dns-hosts

Specifies the absolute path of the hosts file used for host name resolution in a non-DNS environment.

Note: Although this option is supported by the CDF Installer, its use is strongly discouraged to avoid using DNS resolution in production environments, due to hostname resolution issues and the nuances involved in their mitigations.

--load-balancer-host

IP address or host name of load balancer used for communication between the master nodes. For a multiple master node cluster, it is required to provide –load-balancer-host or –ha-virtual-ip arguments.

--master-api-ssl-port

Specifies the https port for the Kubernetes (K8S) API server. The default is 8443.

--nfs-folder Specifies the path to the NFS core volume.
--nfs-server Address of the NFS host.

--pod-cidr-subnetlen

 

Specifies the size of the subnet allocated to each host for pod network addresses.

--pod-cidr

Specifies the private network address range for the Kubernetes pods. Default is 172.16.0.0/16. The minimum useful network prefix is /24. The maximum useful network prefix is /8.

This must not overlap with any IP ranges assigned to services (see --service-cidr parameter below) in Kubernetes. The default is 172.16.0.0/16.

--registry_orgname

The organization inside the public Docker registry name where suite images are located. Not mandatory.

Select one of the following:

  • Specify your own organization name (such as your company name). For example: --registry-orgname=Mycompany.
  • Skip this parameter. A default internal registry will be created under the default name HPESWITOM.

--runtime-home

Specifies the absolute path for placing Kubernetes runtime data. By default, the runtime data directory is ${K8S_HOME}/data.

--service-cidr

 

Kubernetes service IP range. Default is 172.30.78.0/24. Must not overlap the POD_CIDR range.

Specifies the network address for the Kubernetes services. The minimum useful network prefix is /27 and the maximum network prefix is /12. If SERVICE_CIDR is not specified, then the default value is 172.17.17.0/24. This must not overlap with any IP ranges assigned to nodes for pods. See --pod-cidr.

--skip-check-on-node-lost

Option used to skip the time synchronization check if the node is lost. The default is true.

--skip-warning

Option used to skip the warnings in precheck when installing the Initial master Node. Set to true or false. The default is false.

--system-group-id

 

The group ID exposed on server; default is 1999.

--system-user-id

The user ID exposed on server; default is 1999.

--thinpool-device

Specifies the path to the Docker devicemapper, which must be in the /dev/mapper/ directory. For example:

/dev/mapper/docker-thinpool

--tmp-folder

 

Specifies the absolute path of the temporary folder for placing temporary files. The default temporary folder is /tmp.

-h, --help

Displays a help message explaining proper parameter usage

-m, --metadata

 

Specifies the absolute path of the tar.gz suite metadata packages.

Azure CDF install Script Command Line Arguments (Optional)

Argument

Description

-c, --config

 

Absolute path of the configuration json file for silent installation.

-d, --deployment-name, -n

 

Deployment name for suite installation. (Note: -n is to be deprecated in future versions.)

--backup-vol-size

 

Specifies the volume size of pg-backup component. The size must be a plain integer or as a fixed-point integer and the unit must be one of E,P,T,G,M,K,Ei,Pi,Ti,Gi,Mi,Ki; example: 10Gi

-fg, --feature-gates

 

A set of key=value pairs that describe feature gates for alpha/experimental features. The allowable value of this parameter is mapStringBool. Comma-delimited list of strings, each entry format is NameOfFeature=true|false. Options are:

  • MultipleDeployment=true|false (Alpha - default=false)
  • Bosun=true|false (Alpha - default=false)
  • Prometheus=true|false (Alpha - default=false)
--nfs-server Specifies the server for NFS, used to create persistent volume claim 'itom-vol-claim'

--nfs-folder

 

Specifies the folder for NFS, used to create persistent volume claim 'itom-vol-claim'.

--loadbalancer-info

 

Specifies the loadbalancer info. This parameter value formats such as: "KEY1=VALUE1;KEY2=VALUE2;...;KEYn=VALUEn"

Example: For gcp: --loadbalancer-info "LOADBALANCERIP=x.x.x.x"

For alicloud: --loadbalancer-info "LOADBALANCERID=xxx"

--logging-vol-size

 

Specifies the volume size of fluentd component. The size must be a plain integer or as a fixed-point integer and the unit must be one of E,P,T,G,M,K,Ei,Pi,Ti,Gi,Mi,Ki; example: 10Gi

-P, password

Specifies the password for suite administrator which will be created during installation. Wrap the password with single quotes. For example, 'Password@#$!123'.

--registry-orgname

 

Specifies the organization name(namespace) where the suite images are placed. The default name is 'hpeswitom'.

--registry-ca

Specifies the path of trusted CA root certificate (bas64 X.509 format) of external registry.

--registry-password

Specifies the password for registry.

--registry-password-file Specifies the password file for registry.
--skip-warning Option used to skip the warning(s) in precheck when install.
--tmp-folder Specifies the absolute path of the temporary folder for placing temporary files. The default temporary folder is '/tmp'.
--db-user External suite database user name. 
--db-password External suite database password. 
--db-url External suite database connection URL. 

--db-crt

External suite database connection certificate. 
--registry-url Specifies the registry for URL.
--registry-username Specifies the username for registry.
--external-access-host Specifies the external access host.
--cloud-provider Specifies the cloud provider when installing CDF on a cloud server. The allowable value of this parameter is 'alicloud', 'gcp' (case- sensitive)