onboard¶

Contents¶

Onboarding service provides APIs to add/update subscription info for Portworx services.

rpc CreateAccountRegistration(CreateAccountRegistrationRequest) AccountRegistration

creates a new account registration request.

rpc UpdateAccountRegistration(UpdateAccountRegistrationRequest) AccountRegistration

For updating account subscription info.

Account Configuration Info used for Registration.

Field	Type	Description
account_config	public.portworx.platform.account.v1.Config	Desired configuration of the Account.
oneof pds_subscription_info.pds_aws_registration_token	string	AWS registration token.
oneof pds_subscription_info.pds_zuora_subscription	public.portworx.platform.account.v1.ZuoraSubscriptionInfo	Zuora subscription info.
oneof pxe_subscription_info.pxe_aws_registration_token	string	AWS registration token.
oneof pxe_subscription_info.pxe_zuora_subscription	public.portworx.platform.account.v1.ZuoraSubscriptionInfo	Zuora subscription info.
oneof baas_subscription_info.baas_aws_registration_token	string	AWS registration token.
oneof baas_subscription_info.baas_zuora_subscription	public.portworx.platform.account.v1.ZuoraSubscriptionInfo	Zuora subscription info.

AccountRegistration has all details about the account and its subscriptions.

Field	Type	Description
meta	public.portworx.common.v1.Meta	Metadata of the account.
config	AccountConfig	Configuration info used for registering the account.

CreateRegistrationRequest to create account.

Field	Type	Description
account_registration	AccountRegistration	account to be created and onboarded.

UpdateRegistrationRequest currently supports only name update.

Field	Type	Description
account_registration	AccountRegistration	account for which subscription info needs to be updated.

.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