Chapter 10. ClusterInitService

10.1. GetCAConfig

GET /v1/cluster-init/ca-config

10.1.1. Description

10.1.2. Parameters

10.1.3. Return Type

V1GetCAConfigResponse

10.1.4. Content Type

application/json

10.1.5. Responses

Table 10.1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetCAConfigResponse
0	An unexpected error response.	RuntimeError

10.1.6. Samples

10.1.7. Common object reference

10.1.7.1. ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

10.1.7.1.1. JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

10.1.7.2. RuntimeError

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

10.1.7.3. V1GetCAConfigResponse

Field Name	Required	Nullable	Type	Description	Format
helmValuesBundle			byte[]		byte

10.2. GetInitBundles

GET /v1/cluster-init/init-bundles

10.2.1. Description

10.2.2. Parameters

10.2.3. Return Type

V1InitBundleMetasResponse

10.2.4. Content Type

application/json

10.2.5. Responses

Table 10.2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1InitBundleMetasResponse
0	An unexpected error response.	RuntimeError

10.2.6. Samples

10.2.7. Common object reference

10.2.7.1. InitBundleMetaImpactedCluster

Field Name	Required	Nullable	Type	Description	Format
name			String
id			String

10.2.7.2. ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.2.7.2.1. JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

10.2.7.3. RuntimeError

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

10.2.7.4. StorageUser

User is an object that allows us to track the roles a user is tied to, and how they logged in.

Field Name	Required	Nullable	Type	Description	Format
id			String
authProviderId			String
attributes			List of StorageUserAttribute
idpToken			String

10.2.7.5. StorageUserAttribute

Field Name	Required	Nullable	Type	Description	Format
key			String
value			String

10.2.7.6. V1InitBundleMeta

Field Name	Type	Format
id	String
name	String
impactedClusters	List of InitBundleMetaImpactedCluster
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

10.2.7.7. V1InitBundleMetasResponse

Field Name	Required	Nullable	Type	Description	Format
items			List of V1InitBundleMeta

10.3. GenerateInitBundle

POST /v1/cluster-init/init-bundles

10.3.1. Description

10.3.2. Parameters

10.3.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V1InitBundleGenRequest	X

10.3.3. Return Type

V1InitBundleGenResponse

10.3.4. Content Type

application/json

10.3.5. Responses

Table 10.3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1InitBundleGenResponse
0	An unexpected error response.	RuntimeError

10.3.6. Samples

10.3.7. Common object reference

10.3.7.1. InitBundleMetaImpactedCluster

Field Name	Required	Nullable	Type	Description	Format
name			String
id			String

10.3.7.2. ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.3.7.2.1. JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

10.3.7.3. RuntimeError

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

10.3.7.4. StorageUser

User is an object that allows us to track the roles a user is tied to, and how they logged in.

Field Name	Required	Nullable	Type	Description	Format
id			String
authProviderId			String
attributes			List of StorageUserAttribute
idpToken			String

10.3.7.5. StorageUserAttribute

Field Name	Required	Nullable	Type	Description	Format
key			String
value			String

10.3.7.6. V1InitBundleGenRequest

Field Name	Required	Nullable	Type	Description	Format
name			String

10.3.7.7. V1InitBundleGenResponse

Field Name	Type	Format
meta	V1InitBundleMeta
helmValuesBundle	byte[]	byte
kubectlBundle	byte[]	byte

10.3.7.8. V1InitBundleMeta

Field Name	Type	Format
id	String
name	String
impactedClusters	List of InitBundleMetaImpactedCluster
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

10.4. RevokeInitBundle

PATCH /v1/cluster-init/init-bundles/revoke

RevokeInitBundle deletes cluster init bundle. If this operation impacts any cluster then its ID should be included in request. If confirm_impacted_clusters_ids does not match with current impacted clusters then request will fail with error that includes all impacted clusters.

10.4.1. Description

10.4.2. Parameters

10.4.2.1. Body Parameter

Name	Description	Required	Default	Pattern
body	V1InitBundleRevokeRequest	X

10.4.3. Return Type

V1InitBundleRevokeResponse

10.4.4. Content Type

application/json

10.4.5. Responses

Table 10.4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1InitBundleRevokeResponse
0	An unexpected error response.	RuntimeError

10.4.6. Samples

10.4.7. Common object reference

10.4.7.1. InitBundleMetaImpactedCluster

Field Name	Required	Nullable	Type	Description	Format
name			String
id			String

10.4.7.2. InitBundleRevokeResponseInitBundleRevocationError

Field Name	Required	Nullable	Type	Description	Format
id			String
error			String
impactedClusters			List of InitBundleMetaImpactedCluster

10.4.7.3. ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.4.7.3.1. JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

10.4.7.4. RuntimeError

Field Name	Type	Format
error	String
code	Integer	int32
message	String
details	List of ProtobufAny

10.4.7.5. V1InitBundleRevokeRequest

Field Name	Required	Nullable	Type	Description	Format
ids			List of `string`
confirmImpactedClustersIds			List of `string`

10.4.7.6. V1InitBundleRevokeResponse

Field Name	Required	Nullable	Type	Description	Format
initBundleRevocationErrors			List of InitBundleRevokeResponseInitBundleRevocationError
initBundleRevokedIds			List of `string`

Chapter 10. ClusterInitService

10.1. GetCAConfig

10.1.1. Description

10.1.2. Parameters

10.1.3. Return Type

10.1.4. Content Type

10.1.5. Responses

10.1.6. Samples

10.1.7. Common object reference

10.1.7.1. ProtobufAny

10.1.7.1.1. JSON representation

10.1.7.2. RuntimeError

10.1.7.3. V1GetCAConfigResponse

10.2. GetInitBundles

10.2.1. Description

10.2.2. Parameters

10.2.3. Return Type

10.2.4. Content Type

10.2.5. Responses

10.2.6. Samples

10.2.7. Common object reference

10.2.7.1. InitBundleMetaImpactedCluster

10.2.7.2. ProtobufAny

10.2.7.2.1. JSON representation

10.2.7.3. RuntimeError

10.2.7.4. StorageUser

10.2.7.5. StorageUserAttribute

10.2.7.6. V1InitBundleMeta

10.2.7.7. V1InitBundleMetasResponse

10.3. GenerateInitBundle

10.3.1. Description

10.3.2. Parameters

10.3.2.1. Body Parameter

10.3.3. Return Type

10.3.4. Content Type

10.3.5. Responses

10.3.6. Samples

10.3.7. Common object reference

10.3.7.1. InitBundleMetaImpactedCluster

10.3.7.2. ProtobufAny

10.3.7.2.1. JSON representation

10.3.7.3. RuntimeError

10.3.7.4. StorageUser

10.3.7.5. StorageUserAttribute

10.3.7.6. V1InitBundleGenRequest

10.3.7.7. V1InitBundleGenResponse

10.3.7.8. V1InitBundleMeta

10.4. RevokeInitBundle

10.4.1. Description

10.4.2. Parameters

10.4.2.1. Body Parameter

10.4.3. Return Type

10.4.4. Content Type

10.4.5. Responses

10.4.6. Samples

10.4.7. Common object reference

10.4.7.1. InitBundleMetaImpactedCluster

10.4.7.2. InitBundleRevokeResponseInitBundleRevocationError

10.4.7.3. ProtobufAny

10.4.7.3.1. JSON representation

10.4.7.4. RuntimeError

10.4.7.5. V1InitBundleRevokeRequest

10.4.7.6. V1InitBundleRevokeResponse

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

Red Hat legal and privacy links

Red Hat legal and privacy links