CLI Client

Cloud platform parameters

Cloud platform parameters are an advanced feature of Scalable Pixel Streaming and allow you to specify cloud-specific options with your applications. When used with the SPS Client there are two ways in which you can supply your cloud platform parameters:

1. On the command-line using the --cloud-params flag
2. From a file using the --cloud-params-file flag

The --cloud-params and --cloud-params-file flags are supported on the application create and application update commands of the SPS Client. See the managing applications documentation for more information about these commands.

Using the --cloud-params flag

To create an application using the --cloud-params flag run the following command:

sps-client application create --name myapp --cloud-params <cloud-params>

Windows example

An example of using the --cloud-params flag on Windows:

sps-client application create --name myapp --cloud-params '{\"hardware\":[{\"regions\":[\"LGA1\"],\"weight\":100}]}'

Linux example

An example of using the --cloud-params flag on Windows:

sps-client application create --name myapp --cloud-params '{"hardware":[{"regions":["LGA1"],"weight":100}]}'

Using the --cloud-params-file flag

To create an application using the --cloud-params-file flag run the following command, changing the <path/to/cloud-params.json> with your file path:

sps-client application create --name myapp --cloud-params-file <path/to/cloud-params.json>

Windows example

An example of using the --cloud-params-file flag on Windows:

sps-client application create --cloud-params-file "C:\Users\Example\cloud-params.json"

Linux example

An example of using the --cloud-params-file flag on Linux:

sps-client application create --cloud-params-file /home/user/cloud-params.json

Reference

The following is a reference describing all the options available for the --cloud-params and --cloud-params-file flags on CoreWeave.

To set the LGA1 region as the preferred region:

{
    "hardware": [
        {
            "regions": [
                "LGA1"
            ],
            "weight": 100
        }
    ]
}

To set the LGA1 and ORD1 as the preferred regions:

{
    "hardware": [
        {
            "regions": [
                "LGA1",
                "ORD1"
            ],
            "weight": 100
        }
    ]
}

To set the LGA1 region as the preferred region and ORD1 as the secondary region:

{
    "hardware": [
        {
            "regions": [
                "LGA1"
            ],
            "weight": 100
        },
        {
            "regions": [
                "ORD1"
            ],
            "weight": 80
        }
    ]
}

To set the Quadro_RTX_5000 as the preferred GPU:

{
    "hardware": [
        {
            "gpus": [
                "Quadro_RTX_5000"
            ],
            "weight": 100
        }
    ]
}

To set the Quadro_RTX_5000 and Quadro_RTX_4000 as the preferred GPU:

{
    "hardware": [
        {
            "gpus": [
                "Quadro_RTX_5000",
                "Quadro_RTX_4000"
            ],
            "weight": 100
        }
    ]
}

To set the Quadro_RTX_5000 GPU as the preferred GPU and Quadro_RTX_4000 as the secondary GPU:

{
    "hardware": [
        {
            "gpus": [
                "Quadro_RTX_5000"
            ],
            "weight": 100
        },
        {
            "gpus": [
                "Quadro_RTX_4000"
            ],
            "weight": 80
        }
    ]
}

To set Quadro_RTX_5000 as the preferred GPU and LGA1 as the preferred region and Quadro_RTX_4000 as the secondary GPU and LAS1 as the secondary region:

{
    "hardware": [
        {
            "gpus": [
                "Quadro_RTX_5000"
            ],
            "regions": [
                "LGA1"
            ],
            "weight": 100
        },
        {
            "gpus": [
                "Quadro_RTX_4000"
            ],
            "regions": [
                "LGA1"
            ],
            "weight": 80
        }
    ]
}