services command

Manage Tethys Services.

usage: tethys services [-h] {remove,create,list} ...

Sub-commands

remove

Remove a Tethys Service.

tethys services remove [-h] {persistent,spatial,dataset,wps,secure-map} ...

Sub-commands

persistent

Remove a Persistent Store Service.

tethys services remove persistent [-h] [-f] service_uid

Positional Arguments

service_uid: The ID or name of the Persistent Store Service that you are removing.

Named Arguments

-f, --force

Force removal without confirming.

Default: False

spatial

Remove a Spatial Dataset Service.

tethys services remove spatial [-h] [-f] service_uid

Positional Arguments

service_uid: The ID or name of the Spatial Dataset Service that you are removing.

Named Arguments

-f, --force

Force removal without confirming.

Default: False

dataset

Remove a Dataset Service.

tethys services remove dataset [-h] [-f] service_uid

Positional Arguments

service_uid: The ID or name of the Dataset Service that you are removing.

Named Arguments

-f, --force

Force removal without confirming.

Default: False

wps

Remove a WPS Service.

tethys services remove wps [-h] [-f] service_uid

Positional Arguments

service_uid: The ID or name of the WPS Service that you are removing.

Named Arguments

-f, --force

Force removal without confirming.

Default: False

secure-map

Remove a Secure Map Service.

tethys services remove secure-map [-h] [-f] service_uid

Positional Arguments

service_uid: The ID or name of the Secure Map Service that you are removing.

Named Arguments

-f, --force

Force removal without confirming.

Default: False

create

Create a Tethys Service.

tethys services create [-h] {persistent,spatial,dataset,wps,secure-map} ...

Sub-commands

persistent

Create a Persistent Store Service.

tethys services create persistent [-h] -n NAME [-c CONNECTION] [-d DIR_PATH]
                                  [-t {postgres,sqlite}]

Named Arguments

-n, --name

A unique name for the Service

-c, --connection

The connection of the Service in the form "<username>:<password>@<host>:<port>"

-d, --dir_path

The directory path for the SQLite database file (only required if type is sqlite).

-t, --type

Possible choices: postgres, sqlite

Type of persistent store service being created (postgres/sqlite). Default is postgres.

Default: 'postgres'

spatial

Create a Spatial Dataset Service.

tethys services create spatial [-h] -n NAME [-t {GeoServer,THREDDS}]
                               [-c CONNECTION] [-e ENDPOINT]
                               [-p PUBLIC_ENDPOINT] [-k APIKEY]

Named Arguments

-n, --name

A unique name for the Service

-t, --type

Possible choices: GeoServer, THREDDS

Type of spatial dataset service being created (GeoServer/THREDDS).

Default: 'GeoServer'

-c, --connection

The connection of the Service in the form "<username>:<password>@<protocol>//<host>:<port>"

-e, --endpoint

The endpoint of the Service of the form, if connection argument is not provided, "<host>:<port>"

-p, --public-endpoint

The public-facing endpoint, if different than what was provided with the --connection argument, of the form "<host>:<port>"

-k, --apikey

The API key, if any, required to establish a connection.

dataset

Create a CKAN/HydroShare Dataset Service.

tethys services create dataset [-h] -n NAME -t {CKAN,HydroShare} -c CONNECTION
                               [-p PUBLIC_ENDPOINT] [-k APIKEY]

Named Arguments

-n, --name

A unique name for the Service

-t, --type

Possible choices: CKAN, HydroShare

Type of dataset service being created (CKAN/HydroShare).

-c, --connection

The connection of the Service in the form "<username>:<password>@<protocol>//<host>:<port>"

-p, --public-endpoint

The public-facing endpoint, if different than what was provided with the --connection argument, of the form "<host>:<port>"

-k, --apikey

The API key, if any, required to establish a connection.

wps

Create a Web Processing Service.

tethys services create wps [-h] -n NAME -c CONNECTION

Named Arguments

-n, --name: A unique name for the Service
-c, --connection: The connection of the Service in the form "<username>:<password>@<protocol>//<host>:<port>"

secure-map

Create a Secure Map Service.

tethys services create secure-map [-h] -n NAME -e ENDPOINT -l LEGEND_TITLE -a
                                  {api_key,oauth2} [-k API_KEY]
                                  [-o OAUTH2_PROVIDER] -t
                                  {image_wms,gml,geojson,rest} [-p PARAMS]
                                  [--use-proxy]
                                  [--connection-timeout CONNECTION_TIMEOUT]
                                  [--read-timeout READ_TIMEOUT]

Named Arguments

-n, --name

A unique name for the Service

-e, --endpoint

The endpoint URL of the Secure Map Service.

-l, --legend-title

The title to use for the legend when this service is added as a layer on a map.

-a, --auth-method

Possible choices: api_key, oauth2

The authentication method for the service (api_key/oauth2).

-k, --api-key

The API key for the service, if authentication method is api_key.

-o, --oauth2-provider

The OAuth2 provider name, if authentication method is oauth2 (e.g. 'grid').

-t, --service-type

Possible choices: image_wms, gml, geojson, rest

The type of map service (image_wms/gml/geojson/rest).

-p, --params

A JSON string of parameters to include in requests to the service (e.g. '{"LAYERS": "my_layer", "VERSION": "1.3.0"}').

Default: '{}'

--use-proxy

Route requests through a proxy endpoint to keep credentials server-side.

Default: False

--connection-timeout

Timeout in seconds for establishing a connection to the service. Default is 10.

Default: 10

--read-timeout

Timeout in seconds to wait for a response from the service. Default is 30.

Default: 30

list

List all existing Tethys Services.

tethys services list [-h] [-p | -s | -d | -w | -m]

Named Arguments

-p, --persistent

Only list Persistent Store Services.

Default: False

-s, --spatial

Only list Spatial Dataset Services.

Default: False

-d, --dataset

Only list Dataset Services.

Default: False

-w, --wps

Only list Web Processing Services.

Default: False

-m, --secure-map

Only list Secure Map Services.

Default: False

schedulers command

settings command