dataservicedeployment

Contents

• Services

  • DataServiceDeploymentService

• Messages

  • Config
  • CreateDataServiceDeploymentRequest
  • CreateDataServiceDeploymentWithScheduledBackupRequest
  • DataServiceDeployment
  • DataServiceDeploymentCredentials
  • DeleteDataServiceDeploymentRequest
  • GetDataServiceDeploymentCredentialsRequest
  • GetDataServiceDeploymentRequest
  • KeyPerformanceIndicators
  • ListDataServiceDeploymentsRequest
  • ListDataServiceDeploymentsResponse
  • References
  • Status
  • TLSConfig

• Scalar Value Types

DataServiceDeploymentService

DataServiceDeploymentService serves DataService Deployment resource APIs.

CreateDataServiceDeployment

rpc CreateDataServiceDeployment(CreateDataServiceDeploymentRequest) DataServiceDeployment

CreateDataServiceDeployment API creates the Deployment resource.

CreateDataServiceDeploymentWithScheduledBackup

rpc CreateDataServiceDeploymentWithScheduledBackup(CreateDataServiceDeploymentWithScheduledBackupRequest) DataServiceDeployment

CreateDataServiceDeploymentWithScheduledBackup API creates both Deployment and backup configuration resources. (-- api-linter: core::0136::prepositions=disabled aip.dev/not-precedent: We need to do this because this is seperate endpoint for creating deployment along with backupconfig. --)

GetDataServiceDeployment

rpc GetDataServiceDeployment(GetDataServiceDeploymentRequest) DataServiceDeployment

GetDataServiceDeployment API returns the DataService Deployment resource.

DeleteDataServiceDeployment

rpc DeleteDataServiceDeployment(DeleteDataServiceDeploymentRequest) .google.protobuf.Empty

DeleteDataServiceDeployment API deletes the DataService Deployment resource.

ListDataServiceDeployments

rpc ListDataServiceDeployments(ListDataServiceDeploymentsRequest) ListDataServiceDeploymentsResponse

(-- api-linter: core::0132::http-body=disabled api-linter: core::0132::http-method=disabled aip.dev/not-precedent: We need to do this because we can't have advance filters as query params. --) ListDataServiceDeployments API lists the DataService Deployment resources.

GetKeyPerformanceIndicators

rpc GetKeyPerformanceIndicators(ListDataServiceDeploymentsRequest) KeyPerformanceIndicators

(-- api-linter: core::0132::http-body=disabled api-linter: core::0132::http-method=disabled api-linter: core::0131::request-message-name=disabled api-linter: core::0131::http-body=disabled api-linter: core::0131::http-method=disabled aip.dev/not-precedent: We need to do this because reasons. --) GetKeyPerformanceIndicator API return the analytics of the DataService Deployment resources.

GetDataServiceDeploymentCredentials

rpc GetDataServiceDeploymentCredentials(GetDataServiceDeploymentCredentialsRequest) DataServiceDeploymentCredentials

GetDataServiceDeploymentCredentials API returns the Credentials to be used to access the DataService Deployment.

Messages

Config

Desired configuration of the DataService Deployment.

Field	Type	Description
references	References	References to other objects.
tls_config	TLSConfig	TLS configuration for the Data Service.
data_service_deployment_topologies	repeated public.portworx.pds.dataservicedeploymenttopology.v1.DataServiceDeploymentTopology	A DataService deployment topology contains a number of nodes that have various attributes as a collective group.

CreateDataServiceDeploymentRequest

Request to create the DataService Deployment resource.

Field	Type	Description
namespace_id	string	UID of the namespace resource where this DataService deployment will be created. (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the namespace context. --)
project_id	string	UID of the project. (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to know the project with which the deployment is associated with. --)
data_service_deployment	DataServiceDeployment	DataService Deployment resource.

CreateDataServiceDeploymentWithScheduledBackupRequest

Request to create the DataService Deployment resource with scheduled backup configuration.

Field	Type	Description
namespace_id	string	UID of the namespace resource where this DataService deployment will be created. (-- api-linter: core::0133::request-required-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the namespace context. --) (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to support creation of the resource in the namespace context. --)
project_id	string	UID of the project. (-- api-linter: core::0133::request-required-fields=disabled aip.dev/not-precedent: We need this field for to know the project with which the deployment is associated with. --) (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to know the project with which the deployment is associated with. --)
backup_config	public.portworx.pds.backupconfig.v1.Config	Backup configuration for the DataService Deployment. (-- api-linter: core::0133::request-unknown-fields=disabled aip.dev/not-precedent: We need this field for to know the backup location id for taking backup. --)
data_service_deployment	DataServiceDeployment	DataService Deployment resource.

DataServiceDeployment

Resource representing a DataService Deployment.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the resource.
config	Config	Desired configuration of the DataService Deployment.
status	Status	Current status of the DataService Deployment.

DataServiceDeploymentCredentials

Credentials to access a DataService Deployment.

Field	Type	Description
secret	string	secret to access the resource.

DeleteDataServiceDeploymentRequest

Request to delete the DataService Deployment resource.

Field	Type	Description
id	string	UID of the DataService Deployment.
force	bool	Force flag to delete backup configuration from control plane only.

GetDataServiceDeploymentCredentialsRequest

Request to get the DataService Deployment Credentials resource.

Field	Type	Description
id	string	UID of the DataService Deployment.

GetDataServiceDeploymentRequest

Request to get the DataService Deployment resource.

Field	Type	Description
id	string	UID of the DataService Deployment.

KeyPerformanceIndicators

Response to GetKeyPerformanceIndicator

Field	Type	Description
data_service_deployment_available_count	int32	count of available data service deployments.
data_service_deployment_partially_available_count	int32	count of partially available data service deployments.
data_service_deployment_unavailable_count	int32	count of unavailable data service deployments.
data_service_deployment_unknown_count	int32	count of unknown data service deployments.
data_service_deployment_not_applicable_count	int32	count of unknown data service deployments.
running_instances	int32	count of running instances.
not_running_instances	int32	count of not running instances.

ListDataServiceDeploymentsRequest

Request to list the data service deployment resources.

Field	Type	Description
tenant_id	string	Tenant (Organization) ID for which data service deployments need to be fetched.
label_selector	public.portworx.common.v1.Selector	Provides the key in labels and associated values for which data service deployments need to be listed.
field_selector	public.portworx.common.v1.Selector	Field selector is used to filter data service deployments based on the fields in the deployments's proto message.
infra_resource_selector	public.portworx.common.v1.ResourceSelector	Infra_resource_selector is used to filter deployments based on the infra resources associated with the data service deployments. Supported infra resource filters: PROJECT, CLUSTER, NAMESPACE.
sort	public.portworx.common.v1.Sort	Sorting details using which requested list of data service deployments to be sorted.
pagination	public.portworx.common.v1.PageBasedPaginationRequest	Pagination parameters for listing data service deployments.
application_selector	public.portworx.pds.common.v1.PDSApplicationSelector	application_selector is used to filter deployments based on the application resources which were used to create the deployments.

ListDataServiceDeploymentsResponse

Response to list DataService Deployment request.

Field	Type	Description
data_service_deployments	repeated DataServiceDeployment	List of DataService deployment resources.
pagination	public.portworx.common.v1.PageBasedPaginationResponse	Pagination metadata for this response. (-- api-linter: core::0132::response-unknown-fields=disabled aip.dev/not-precedent: We need this field for pagination. --)

References

References to other resources.

Field	Type	Description
target_cluster_id	string	UID of the target cluster in which Data Service will be deployed.
image_id	string	UID of the image to be used for the Data Service Deployment.
project_id	string	UID of the project to which DataService Deployment associated.
restore_id	string	UID of the restore id for the data service Deployment.
data_service_id	string	UID of the data service.
data_service_version_id	string	UID of the data service version.

Status

Status of the DataService Deployment.

Field	Type	Description
health	Status.Health	Health of the DataService Deployment.
phase	Status.Phase	Status of the DataService Deployment.
connection_info	google.protobuf.Struct	ConnectionDetails urls, ports, credentials, etc for connecting to the data service.
initialized	string	Initialize used to control startup scripts.
data_service_deployment_topology_status	repeated public.portworx.pds.dataservicedeploymenttopology.v1.DataServiceDeploymentTopologyStatus	Status of the deployment topology.
custom_resource_name	string	Custom Resource Name is the kubernetes resource name for the deployment that is built from ID.
dns_zone	string	dns zone of the deployment.
manifest_time	google.protobuf.Timestamp	last manifest reporting time.
error_code	string	error_code.
error_message	string	error message.

TLSConfig

TLS configuration for the Data Service.

Field	Type	Description
enabled	bool	Flag to enable TLS for the Data Service.
issuer_name	string	Issuer (Certificate Authority) name for the TLS certificates.

Enums

Status.Health

Enum for Health of the DataService Deployment.

Name	Number	Description
HEALTH_UNSPECIFIED	0	Health is unspecified.
AVAILABLE	1	DataService Deployment is Available.
PARTIALLY_AVAILABLE	2	DataService Deployment is PartiallyAvailable.
UNAVAILABLE	3	DataService Deployment is Unavailable.
NOT_APPLICABLE	4	DataService Deployment is deleted from cluster.

Status.Phase

Enum for Status of the DataService Deployment.

Name	Number	Description
PHASE_UNSPECIFIED	0	Phase is unspecified.
RESTORING	1	Restore of DataService Deployment is in progress.
FAILED	2	DataService Deployment is Failed.
DELETING	3	DataService Deployment is being deleted.
PREPARING	4	DataService Deployment is Preparing.
DEPLOYING	5	DataService Deployment is Deploying.
DEPLOYED	6	DataService Deployment is Deployed.
UPDATING	7	DataService Deployment is Updating.
TIMED_OUT	8	DataService Deployment is Timeout.
DELETED_FROM_CLUSTER	9	DataService Deployment is deleted from cluster.

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str