environment#
Manage execution environments on Posit Connect.
Usage:
environment [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
environment add#
Create a new execution environment.
Usage:
environment add [OPTIONS] IMAGE
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-T, --title TEXT A human-readable title for the environment.
-d, --description TEXT A description for the environment.
-m, --matching [any|exact|none]
The image selection strategy.
--supervisor TEXT Path to the per-image supervisor script.
--python TEXT A Python installation as VERSION=PATH.
Example:
3.11.6=/opt/python/3.11.6/bin/python
--quarto TEXT A Quarto installation as VERSION=PATH.
Example:
1.4.555=/opt/quarto/1.4.555/bin/quarto
--r TEXT An R installation as VERSION=PATH. Example:
4.3.2=/opt/R/4.3.2/bin/R
--tensorflow TEXT A TensorFlow installation as VERSION=PATH.
Example: 2.14.0=/opt/tensorflow/2.14.0
--mount TEXT A volume mount as comma-separated key=value
pairs. Required keys: type (nfs or pvc),
target. NFS example: type=nfs,nfs_host=nas.e
xample.com,nfs_export_path=/shared/data,targ
et=/mnt/data. PVC example:
type=pvc,pvc_name=my-
claim,target=/mnt/storage,read_only=true
--allow-user STRIPPEDSTRING A user GUID to grant access.
--allow-group STRIPPEDSTRING A group GUID to grant access.
--clear-permissions Remove all existing permissions.
--help Show this message and exit.
environment edit#
Update an existing execution environment.
Usage:
environment edit [OPTIONS] GUID
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
-T, --title TEXT A new title for the environment.
-d, --description TEXT A new description for the environment.
-m, --matching [any|exact|none]
The image selection strategy.
--supervisor TEXT Path to the per-image supervisor script.
--python TEXT A Python installation as VERSION=PATH.
Example:
3.11.6=/opt/python/3.11.6/bin/python
--quarto TEXT A Quarto installation as VERSION=PATH.
Example:
1.4.555=/opt/quarto/1.4.555/bin/quarto
--r TEXT An R installation as VERSION=PATH. Example:
4.3.2=/opt/R/4.3.2/bin/R
--tensorflow TEXT A TensorFlow installation as VERSION=PATH.
Example: 2.14.0=/opt/tensorflow/2.14.0
--mount TEXT A volume mount as comma-separated key=value
pairs. Required keys: type (nfs or pvc),
target. NFS example: type=nfs,nfs_host=nas.e
xample.com,nfs_export_path=/shared/data,targ
et=/mnt/data. PVC example:
type=pvc,pvc_name=my-
claim,target=/mnt/storage,read_only=true
--allow-user STRIPPEDSTRING A user GUID to grant access.
--allow-group STRIPPEDSTRING A group GUID to grant access.
--clear-permissions Remove all existing permissions.
--help Show this message and exit.
environment list#
List execution environments.
Usage:
environment list [OPTIONS]
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--help Show this message and exit.
environment remove#
Delete an execution environment.
Usage:
environment remove [OPTIONS] GUID
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--help Show this message and exit.
environment show#
Show a single execution environment.
Usage:
environment show [OPTIONS] GUID
Options:
-n, --name TEXT The nickname of the Posit Connect server to
deploy to.
-s, --server TEXT The URL for the Posit Connect server to
deploy to. (Also settable via CONNECT_SERVER
environment variable.)
-k, --api-key TEXT The API key to use to authenticate with
Posit Connect. (Also settable via
CONNECT_API_KEY environment variable.)
-i, --insecure Disable TLS certification/host validation.
(Also settable via CONNECT_INSECURE
environment variable.)
-c, --cacert FILE The path to trusted TLS CA certificates.
(Also settable via CONNECT_CA_CERTIFICATE
environment variable.)
-v, --verbose Enable verbose output. Use -vv for very
verbose (debug) output.
--snowflake-connection-name TEXT
The name of the Snowflake connection in the
configuration file
--help Show this message and exit.
