Configuration Guide
1. Required Parameters
| Parameter | Description | Default Value |
|---|---|---|
--domain <domain> | Deployment access domain (required, used for subsequent access to CSGHub instance) | None |
2. Optional Parameters
| Parameter | Description | Default Value |
|---|---|---|
--data <data_dir> | Define the data storage directory for the K3s cluster, used to store K3s core data | /var/lib/rancher |
--enable-gpu | Enable NVIDIA GPU support, suitable for scenarios requiring GPU for model training and inference | false |
--enable-nfs-pv | Enable NFS PV Provisioner to provide RWX dynamic shared storage to meet multi-Pod data sharing requirements | true |
--edition | 【Deprecated】Specify version type. It is recommended to pass configuration through --extra-args | ee |
--install-cn | Enable domestic mirror acceleration source to optimize image pulling speed in domestic network environments and solve slow access to overseas resources | false |
--hosts-alias | Enable local hosts domain resolution, automatically add mapping between domain and server IP for quick local access | true |
--extra-args "<args1> <args2>" | Append Helm Chart custom parameters to override default configuration or add additional deployment configurations | None |
--dry-run | Only print deployment execution commands without actually performing the deployment operation, used to verify the correctness of deployment commands | false |
--verbose | Print detailed log information during deployment to facilitate troubleshooting of exceptions during deployment | false |
--ghproxy <url> | Set GitHub proxy address to solve GitHub resource pull failures and slow speeds | https://ghfast.top |
--interface <iface> | Specify the network interface used for deployment to avoid network configuration exceptions caused by multi-NIC environments | Default system first network card |
--timeout <seconds> | Customize timeout for resource creation, in seconds, to adapt to environments where resource creation is slow | Default 300 seconds |
--k3s-server <server_url> | Specify the Master node URL when creating Agent nodes. Specifying this parameter identifies it as adding an Agent node | None |
--k3s-token <server_token> | Specify the Master node token when creating Agent nodes for authentication between Agent and Master nodes | Default stored in /var/lib/rancher/k3s/server/token |
--k3s-version <version> | Specify the Kubernetes version for creating Agent nodes. Must be consistent with the Master node version | Default v1.34.3+k3s1 |
Notes
-
【Deprecated】Parameters should be passed through
--extra-args. The following default configurations are already built into the deployment script:HELM_EXTRA_ARGS+=(--set global.edition='ee')
HELM_EXTRA_ARGS+=(--set global.gateway.service.type=NodePort)You can override default configurations or append more custom configurations in the following way:
curl -sfL http://quick-install.opencsg.com | bash -s -- --domain csghub.example.com --extra-args "--set global.edition='ce'" -
When adding Agent nodes, the deployment script command executed each time must remain consistent and must include all necessary parameters to avoid node configuration exceptions.