ClusterInitService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.5

GenerateInitBundle

POST /v1/cluster-init/init-bundles

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	V1InitBundleGenRequest	X

Name

Description

Required

Default

Pattern

body

V1InitBundleGenRequest

Return Type

V1InitBundleGenResponse

Content Type

application/json

Responses

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

Samples

GetCAConfig

GET /v1/cluster-init/ca-config

Description

Parameters

Return Type

V1GetCAConfigResponse

Content Type

application/json

Responses

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

Samples

GetInitBundles

GET /v1/cluster-init/init-bundles

Description

Parameters

Return Type

V1InitBundleMetasResponse

Content Type

application/json

Responses

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

Samples

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.

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	V1InitBundleRevokeRequest	X

Name

Description

Required

Default

Pattern

body

V1InitBundleRevokeRequest

Return Type

V1InitBundleRevokeResponse

Content Type

application/json

Responses

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

Samples

Common object reference

InitBundleMetaImpactedCluster

Field Name

Required

Nullable

Type

Description

Format

name

String

InitBundleRevokeResponseInitBundleRevocationError

Field Name

Required

Nullable

Type

Description

Format

String

error

String

impactedClusters

List of InitBundleMetaImpactedCluster

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".

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

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

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

RuntimeError

Field Name

Required

Nullable

Type

Description

Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

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

String

authProviderId

String

attributes

List of StorageUserAttribute

idpToken

String

StorageUserAttribute

Field Name

Required

Nullable

Type

Description

Format

key

String

value

String

V1GetCAConfigResponse

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

Field Name

Required

Nullable

Type

Description

Format

helmValuesBundle

byte[]

byte

V1InitBundleGenRequest

Field Name

Required

Nullable

Type

Description

Format

name

String

V1InitBundleGenResponse

Field Name

Required

Nullable

Type

Description

Format

V1InitBundleMeta

Field Name

Required

Nullable

Type

Description

Format

String

name

String

impactedClusters

List of InitBundleMetaImpactedCluster

createdAt

Date

date-time

createdBy

StorageUser

expiresAt

Date

date-time

V1InitBundleMetasResponse

Field Name

Required

Nullable

Type

Description

Format

items

List of V1InitBundleMeta

V1InitBundleRevokeRequest

Field Name Required Nullable Type Description Format

ids

List of string

confirmImpactedClustersIds

List of string

V1InitBundleRevokeResponse

Field Name Required Nullable Type Description Format

initBundleRevocationErrors

List of InitBundleRevokeResponseInitBundleRevocationError

initBundleRevokedIds

List of string