dataservicedeploymenttopology

Contents

• Messages

  • ConnectionDetails
  • ConnectionDetails.PortsEntry
  • ConnectionInfo
  • DataServiceDeploymentTopology
  • DataServiceDeploymentTopologyStatus
  • InstanceInfo
  • Template
  • Template.ValuesEntry

• Scalar Value Types

Messages

ConnectionDetails

ConnectionDetails of data service.

Field	Type	Description
instances	repeated string	Instances of the data service deployment.
ports	map ConnectionDetails.PortsEntry	Ports provided by the data service deployment (name and number).

ConnectionDetails.PortsEntry

Field	Type	Description
key	string	none
value	int32	none

ConnectionInfo

Connection Information for the DataServiceDeployment Topology.

Field	Type	Description
ready_instances	repeated InstanceInfo	Ready instances.
not_ready_instances	repeated InstanceInfo	Instances that are not ready.
connection_details	ConnectionDetails	ConnectionDetails of data service deployment.
cluster_details	google.protobuf.Struct	Stores details about the cluster.

DataServiceDeploymentTopology

A DataService topology contains a number of nodes that have various attributes as a collective group. This is consumed in a DataService Deployment and the functionality is being controlled by the CRUD APIs of DataService Deployment.

Field	Type	Description
name	string	Name of the DataServiceDeployment topology.
description	string	Description of the DataServiceDeployment topology.
instances	int64	Number of instances of data services.
service_type	string	Service type are standard Kubernetes service types such as clusterIP, NodePort, load balancers, etc.
service_name	string	Service name is the name of service as provided by user.
load_balancer_source_ranges	repeated string	Source IP ranges to use for the deployed Load Balancer.
resource_settings	Template	Resource Settings Template.
service_configurations	Template	Service Configurations Template.
storage_options	Template	Storage Options Template.
pod_scheduling_config	public.portworx.pds.common.v1.PodSchedulingConfig	Pod Scheduling Configurations.

DataServiceDeploymentTopologyStatus

Status of the data service topology. It is consumed in DataServiceDeployment.

Field	Type	Description
health	DataServiceDeploymentTopologyStatus.Health	Health of the data service deployment topology.
phase	DataServiceDeploymentTopologyStatus.Phase	Phase of the DataServiceDeployment Topology.
ready_instances	int64	Number of ready replicas reported by Target Cluster that are up and running.
connection_info	ConnectionInfo	Connection Information for the DataServiceDeployment Topology.

InstanceInfo

InstanceInfo contains information about a instance.

Field	Type	Description
ip	string	The IP of a instance.
name	string	Name is the Hostname of a instance.
worker_node	string	Node that hosts a particular instance.

Template

Template.

Field	Type	Description
id	string	UID of the Template.
resource_version	string	Resource version of the template.
values	map Template.ValuesEntry	Values required for template.

Template.ValuesEntry

Field	Type	Description
key	string	none
value	string	none

Enums

DataServiceDeploymentTopologyStatus.Health

Enum for Health of the data service topology.

Name	Number	Description
UNKNOWN	0	Health is unknown.
UNAVAILABLE	1	DataServiceDeployment Topology is Unavailable.
PARTIALLY_AVAILABLE	2	DataServiceDeployment Topology is Partially available.
AVAILABLE	3	DataServiceDeployment Topology is available.

DataServiceDeploymentTopologyStatus.Phase

Enum for Phase of the DataServiceDeployment Topology.

Name	Number	Description
PHASE_UNSPECIFIED	0	Unspecified status.
IN_PROGRESS	1	In progress Status.
PARTIAL_SUCCESS	2	Partial Success Status.
SUCCESS	3	Successful Status.
DELETE_PENDING	4	Delete is pending Status.
DELETING	5	Delete in progress Status.
FAILED	6	Failed Status.
TIMED_OUT	7	Timed Out Status.

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