targetclusterregistrationmanifest¶

Contents¶

TargetClusterRegistrationManifestService provides API to generate registration manifest.

rpc GenerateTargetClusterRegistrationManifest(GenerateTargetClusterRegistrationManifestRequest) TargetClusterRegistrationManifest

GetTargetClusterRegistrationManifest fetches registration manifest for the given request under specified Tenant (Organization).

rpc ReRegisterTargetCluster(ReRegisterTargetClusterRequest) TargetClusterRegistrationManifest

ReRegisterTargetCluster fetches manifest for re-registration of target cluster.

Configuration of the target cluster registration manifest.

Field	Type	Description
custom_image_registry_config	CustomImageRegistryConfig	custom image registry credential configs.
proxy_config	ProxyConfig	custom proxy configs.

CustomImageRegistryConfig holds image registry credential configs.

Field	Type	Description
registry_url	string	registry url/domain, e.g. - in org.example.com/namespace/sub-namespace/repo:tag, here `org.example.com` is the registry url.
registry_namespace	string	registry namespace, e.g. - in org.example.com/namespace/sub-namespace/repo:tag, here `namespace/sub-namespace` is the registry namespace.
username	string	username for authenticating to a private registry.
password	string	password for authenticating to a private registry.
ca_cert	string	ca cert of the registry server.

GetTargetClusterRegistrationManifestRequest is the request message to the GetTargetClusterRegistrationManifest API.

Field	Type	Description
tenant_id	string	tenanat_id is the id of the Tenant (Organization) for which manifest is requested.
cluster_name	string	cluster_name which the user wants to use.
config	Config	Config for generating the manifest.

ProxyConfig holds proxy configs.

Field	Type	Description
http_url	string	http proxy url with port, e.g. - http://192.168.0.1:1234.
https_url	string	https proxy url with port, e.g. - https://192.168.0.1:4567.
username	string	username for authenticating to the proxy server.
password	string	password for authenticating to the proxy server.
no_proxy	string	comma separated no proxy urls list, e.g. - 127.0.0.1,localhost,.svc,192.168.0.1/16,github.com,KUBERNETES_SERVICE_HOST.
ca_cert	string	ca cert of the proxy server.

ReRegisterTargetClusterRequest is the request message to the ReRegisterTargetCluster API.

Field	Type	Description
cluster_id	string	cluster ID is the id of the target cluster already registered with control plane.
config	Config	Config for generating the manifest.

TargetClusterRegistrationManifest is the response message of the GetTargetClusterRegistrationManifest API.

Field	Type	Description
manifest	string	manifest contains the yaml string of the registration manifest.

.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