|
2463 | 2463 |
|
2464 | 2464 | <h1 id="gpustack-start">gpustack start</h1> |
2465 | 2465 | <p>Run GPUStack server or worker.</p> |
2466 | | -<pre class="highlight"><code class="language-bash">gpustack start [OPTIONS]</code></pre> |
| 2466 | +<div class="highlight"><pre><span></span><code>gpustack<span class="w"> </span>start<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span> |
| 2467 | +</code></pre></div> |
2467 | 2468 | <h2 id="configurations">Configurations</h2> |
2468 | 2469 | <h3 id="common-options">Common Options</h3> |
2469 | 2470 | <table> |
@@ -2735,54 +2736,55 @@ <h3 id="available-environment-variables">Available Environment Variables</h3> |
2735 | 2736 | </table> |
2736 | 2737 | <h2 id="config-file">Config File</h2> |
2737 | 2738 | <p>You can configure start options using a YAML-format config file when starting GPUStack server or worker. Here is a complete example:</p> |
2738 | | -<pre class="highlight"><code class="language-yaml"># Common Options |
2739 | | -debug: false |
2740 | | -data_dir: /path/to/data_dir |
2741 | | -cache_dir: /path/to/cache_dir |
2742 | | -token: mytoken |
2743 | | -ollama_library_base_url: https://registry.mycompany.com |
2744 | | -enable_ray: false |
2745 | | -ray_args: ["--port=6379", "--verbose"] |
2746 | | - |
2747 | | -# Server Options |
2748 | | -host: 0.0.0.0 |
2749 | | -port: 80 |
2750 | | -disable_worker: false |
2751 | | -database_url: postgresql://user:password@hostname:port/db_name |
2752 | | -ssl_keyfile: /path/to/keyfile |
2753 | | -ssl_certfile: /path/to/certfile |
2754 | | -force_auth_localhost: false |
2755 | | -bootstrap_password: myadminpassword |
2756 | | -disable_update_check: false |
2757 | | -model_catalog_file: /path_or_url/to/model_catalog_file |
2758 | | -ray_port: 40096 |
2759 | | -ray_client_server_port: 40097 |
2760 | | -enable_cors: false |
2761 | | -allow_origins: ["*"] |
2762 | | -allow_credentials: false |
2763 | | -allow_methods: ["GET", "POST"] |
2764 | | -allow_headers: ["Authorization", "Content-Type"] |
2765 | | - |
2766 | | -# Worker Options |
2767 | | -server_url: http://your_gpustack_server_url |
2768 | | -worker_name: myworker |
2769 | | -worker_ip: 192.168.1.101 |
2770 | | -disable_metrics: false |
2771 | | -disable_rpc_servers: false |
2772 | | -metrics_port: 10151 |
2773 | | -worker_port: 10150 |
2774 | | -service_port_range: 40000-40063 |
2775 | | -rpc_server_port_range: 40064-40095 |
2776 | | -ray_node_manager_port: 40098 |
2777 | | -ray_object_manager_port: 40099 |
2778 | | -ray_worker_port_range: 40100-40131 |
2779 | | -log_dir: /path/to/log_dir |
2780 | | -rpc_server_args: ["--verbose"] |
2781 | | -system_reserved: |
2782 | | - ram: 2 |
2783 | | - vram: 1 |
2784 | | -tools_download_base_url: https://mirror.mycompany.com |
2785 | | -enable_hf_transfer: false</code></pre> |
| 2739 | +<div class="highlight"><pre><span></span><code><span class="c1"># Common Options</span> |
| 2740 | +<span class="nt">debug</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2741 | +<span class="nt">data_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/data_dir</span> |
| 2742 | +<span class="nt">cache_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/cache_dir</span> |
| 2743 | +<span class="nt">token</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mytoken</span> |
| 2744 | +<span class="nt">ollama_library_base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://registry.mycompany.com</span> |
| 2745 | +<span class="nt">enable_ray</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2746 | +<span class="nt">ray_args</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"--port=6379"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"--verbose"</span><span class="p p-Indicator">]</span> |
| 2747 | + |
| 2748 | +<span class="c1"># Server Options</span> |
| 2749 | +<span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0.0.0.0</span> |
| 2750 | +<span class="nt">port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">80</span> |
| 2751 | +<span class="nt">disable_worker</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2752 | +<span class="nt">database_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">postgresql://user:password@hostname:port/db_name</span> |
| 2753 | +<span class="nt">ssl_keyfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/keyfile</span> |
| 2754 | +<span class="nt">ssl_certfile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/certfile</span> |
| 2755 | +<span class="nt">force_auth_localhost</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2756 | +<span class="nt">bootstrap_password</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myadminpassword</span> |
| 2757 | +<span class="nt">disable_update_check</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2758 | +<span class="nt">model_catalog_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path_or_url/to/model_catalog_file</span> |
| 2759 | +<span class="nt">ray_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40096</span> |
| 2760 | +<span class="nt">ray_client_server_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40097</span> |
| 2761 | +<span class="nt">enable_cors</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2762 | +<span class="nt">allow_origins</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"*"</span><span class="p p-Indicator">]</span> |
| 2763 | +<span class="nt">allow_credentials</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2764 | +<span class="nt">allow_methods</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"GET"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"POST"</span><span class="p p-Indicator">]</span> |
| 2765 | +<span class="nt">allow_headers</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"Authorization"</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">"Content-Type"</span><span class="p p-Indicator">]</span> |
| 2766 | + |
| 2767 | +<span class="c1"># Worker Options</span> |
| 2768 | +<span class="nt">server_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">http://your_gpustack_server_url</span> |
| 2769 | +<span class="nt">worker_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">myworker</span> |
| 2770 | +<span class="nt">worker_ip</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">192.168.1.101</span> |
| 2771 | +<span class="nt">disable_metrics</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2772 | +<span class="nt">disable_rpc_servers</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2773 | +<span class="nt">metrics_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10151</span> |
| 2774 | +<span class="nt">worker_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10150</span> |
| 2775 | +<span class="nt">service_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40000-40063</span> |
| 2776 | +<span class="nt">rpc_server_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40064-40095</span> |
| 2777 | +<span class="nt">ray_node_manager_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40098</span> |
| 2778 | +<span class="nt">ray_object_manager_port</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40099</span> |
| 2779 | +<span class="nt">ray_worker_port_range</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40100-40131</span> |
| 2780 | +<span class="nt">log_dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/log_dir</span> |
| 2781 | +<span class="nt">rpc_server_args</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">"--verbose"</span><span class="p p-Indicator">]</span> |
| 2782 | +<span class="nt">system_reserved</span><span class="p">:</span> |
| 2783 | +<span class="w"> </span><span class="nt">ram</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span> |
| 2784 | +<span class="w"> </span><span class="nt">vram</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span> |
| 2785 | +<span class="nt">tools_download_base_url</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://mirror.mycompany.com</span> |
| 2786 | +<span class="nt">enable_hf_transfer</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span> |
| 2787 | +</code></pre></div> |
2786 | 2788 |
|
2787 | 2789 |
|
2788 | 2790 |
|
|
0 commit comments