Package io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1

Class CredentialsRequestSpec

java.lang.Object

io.fabric8.openshift.api.model.miscellaneous.cloudcredential.v1.CredentialsRequestSpec

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<CredentialsRequestSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class CredentialsRequestSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<CredentialsRequestSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

CredentialsRequestSpec defines the desired state of CredentialsRequest

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CredentialsRequestSpec()	No args constructor for use in serialization
CredentialsRequestSpec(String cloudTokenPath, Object providerSpec, io.fabric8.kubernetes.api.model.ObjectReference secretRef, List<String> serviceAccountNames)

Method Summary

Modifier and Type	Method	Description
CredentialsRequestSpecBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getCloudTokenPath()	cloudTokenPath is the path where the Kubernetes ServiceAccount token (JSON Web Token) is mounted on the deployment for the workload requesting a credentials secret.
Object	getProviderSpec()	CredentialsRequestSpec defines the desired state of CredentialsRequest
io.fabric8.kubernetes.api.model.ObjectReference	getSecretRef()	CredentialsRequestSpec defines the desired state of CredentialsRequest
List<String>	getServiceAccountNames()	ServiceAccountNames contains a list of ServiceAccounts that will use permissions associated with this CredentialsRequest.
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setCloudTokenPath(String cloudTokenPath)	cloudTokenPath is the path where the Kubernetes ServiceAccount token (JSON Web Token) is mounted on the deployment for the workload requesting a credentials secret.
void	setProviderSpec(Object providerSpec)	CredentialsRequestSpec defines the desired state of CredentialsRequest
void	setSecretRef(io.fabric8.kubernetes.api.model.ObjectReference secretRef)	CredentialsRequestSpec defines the desired state of CredentialsRequest
void	setServiceAccountNames(List<String> serviceAccountNames)	ServiceAccountNames contains a list of ServiceAccounts that will use permissions associated with this CredentialsRequest.
CredentialsRequestSpecBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CredentialsRequestSpec

public CredentialsRequestSpec()

No args constructor for use in serialization

CredentialsRequestSpec

public CredentialsRequestSpec(String cloudTokenPath,
                              Object providerSpec,
                              io.fabric8.kubernetes.api.model.ObjectReference secretRef,
                              List<String> serviceAccountNames)

Method Detail

getCloudTokenPath

public String getCloudTokenPath()

cloudTokenPath is the path where the Kubernetes ServiceAccount token (JSON Web Token) is mounted on the deployment for the workload requesting a credentials secret. The presence of this field in combination with fields such as spec.providerSpec.stsIAMRoleARN indicate that CCO should broker creation of a credentials secret containing fields necessary for token based authentication methods such as with the AWS Secure Token Service (STS).

cloudTokenPath may also be used to specify the azure_federated_token_file path used in Azure configuration secrets generated by ccoctl. Defaults to "/var/run/secrets/openshift/serviceaccount/token".

setCloudTokenPath

public void setCloudTokenPath(String cloudTokenPath)

cloudTokenPath is the path where the Kubernetes ServiceAccount token (JSON Web Token) is mounted on the deployment for the workload requesting a credentials secret. The presence of this field in combination with fields such as spec.providerSpec.stsIAMRoleARN indicate that CCO should broker creation of a credentials secret containing fields necessary for token based authentication methods such as with the AWS Secure Token Service (STS).

cloudTokenPath may also be used to specify the azure_federated_token_file path used in Azure configuration secrets generated by ccoctl. Defaults to "/var/run/secrets/openshift/serviceaccount/token".

getProviderSpec

public Object getProviderSpec()

CredentialsRequestSpec defines the desired state of CredentialsRequest

setProviderSpec

public void setProviderSpec(Object providerSpec)

CredentialsRequestSpec defines the desired state of CredentialsRequest

getSecretRef

public io.fabric8.kubernetes.api.model.ObjectReference getSecretRef()

CredentialsRequestSpec defines the desired state of CredentialsRequest

setSecretRef

public void setSecretRef(io.fabric8.kubernetes.api.model.ObjectReference secretRef)

CredentialsRequestSpec defines the desired state of CredentialsRequest

getServiceAccountNames

public List<String> getServiceAccountNames()

ServiceAccountNames contains a list of ServiceAccounts that will use permissions associated with this CredentialsRequest. This is not used by CCO, but the information is needed for being able to properly set up access control in the cloud provider when the ServiceAccounts are used as part of the cloud credentials flow.

setServiceAccountNames

public void setServiceAccountNames(List<String> serviceAccountNames)

ServiceAccountNames contains a list of ServiceAccounts that will use permissions associated with this CredentialsRequest. This is not used by CCO, but the information is needed for being able to properly set up access control in the cloud provider when the ServiceAccounts are used as part of the cloud credentials flow.

edit

public CredentialsRequestSpecBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<CredentialsRequestSpecBuilder>

toBuilder

public CredentialsRequestSpecBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)