Skip to main content

Configuration Guide

1. Required Parameters

ParameterDescriptionDefault Value
--domain <domain>Deployment access domain (required, used for subsequent access to CSGHub instance)None

2. Optional Parameters

ParameterDescriptionDefault Value
--data <data_dir>Define the data storage directory for the K3s cluster, used to store K3s core data/var/lib/rancher
--enable-gpuEnable NVIDIA GPU support, suitable for scenarios requiring GPU for model training and inferencefalse
--enable-nfs-pvEnable NFS PV Provisioner to provide RWX dynamic shared storage to meet multi-Pod data sharing requirementstrue
--edition【Deprecated】Specify version type. It is recommended to pass configuration through --extra-argsee
--install-cnEnable domestic mirror acceleration source to optimize image pulling speed in domestic network environments and solve slow access to overseas resourcesfalse
--hosts-aliasEnable local hosts domain resolution, automatically add mapping between domain and server IP for quick local accesstrue
--extra-args "<args1> <args2>"Append Helm Chart custom parameters to override default configuration or add additional deployment configurationsNone
--dry-runOnly print deployment execution commands without actually performing the deployment operation, used to verify the correctness of deployment commandsfalse
--verbosePrint detailed log information during deployment to facilitate troubleshooting of exceptions during deploymentfalse
--ghproxy <url>Set GitHub proxy address to solve GitHub resource pull failures and slow speedshttps://ghfast.top
--interface <iface>Specify the network interface used for deployment to avoid network configuration exceptions caused by multi-NIC environmentsDefault system first network card
--timeout <seconds>Customize timeout for resource creation, in seconds, to adapt to environments where resource creation is slowDefault 300 seconds
--k3s-server <server_url>Specify the Master node URL when creating Agent nodes. Specifying this parameter identifies it as adding an Agent nodeNone
--k3s-token <server_token>Specify the Master node token when creating Agent nodes for authentication between Agent and Master nodesDefault 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 versionDefault 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.