hub.v1alpha1.accessControlPolicy

"AccessControlPolicy defines an access control policy."

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of AccessControlPolicy

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"AccessControlPolicySpec configures an access control policy."

obj spec.apiKey

"AccessControlPolicyAPIKey configure an APIKey control policy."

fn spec.apiKey.withForwardHeaders

withForwardHeaders(forwardHeaders)

"ForwardHeaders instructs the middleware to forward key metadata as header values upon successful authentication."

fn spec.apiKey.withForwardHeadersMixin

withForwardHeadersMixin(forwardHeaders)

"ForwardHeaders instructs the middleware to forward key metadata as header values upon successful authentication."

Note: This function appends passed data to existing values

fn spec.apiKey.withKeys

withKeys(keys)

"Keys define the set of authorized keys to access a protected resource."

fn spec.apiKey.withKeysMixin

withKeysMixin(keys)

"Keys define the set of authorized keys to access a protected resource."

Note: This function appends passed data to existing values

obj spec.apiKey.keySource

"KeySource defines how to extract API keys from requests."

fn spec.apiKey.keySource.withCookie

withCookie(cookie)

"Cookie is the name of a cookie."

fn spec.apiKey.keySource.withHeader

withHeader(header)

"Header is the name of a header."

fn spec.apiKey.keySource.withHeaderAuthScheme

withHeaderAuthScheme(headerAuthScheme)

"HeaderAuthScheme sets an optional auth scheme when Header is set to \"Authorization\".\nIf set, this scheme is removed from the token, and all requests not including it are dropped."

fn spec.apiKey.keySource.withQuery

withQuery(query)

"Query is the name of a query parameter."

obj spec.apiKey.keys

"Keys define the set of authorized keys to access a protected resource."

fn spec.apiKey.keys.withId

withId(id)

"ID is the unique identifier of the key."

fn spec.apiKey.keys.withMetadata

withMetadata(metadata)

"Metadata holds arbitrary metadata for this key, can be used by ForwardHeaders."

fn spec.apiKey.keys.withMetadataMixin

withMetadataMixin(metadata)

"Metadata holds arbitrary metadata for this key, can be used by ForwardHeaders."

Note: This function appends passed data to existing values

fn spec.apiKey.keys.withValue

withValue(value)

"Value is the SHAKE-256 hash (using 64 bytes) of the API key."

obj spec.basicAuth

"AccessControlPolicyBasicAuth holds the HTTP basic authentication configuration."

fn spec.basicAuth.withForwardUsernameHeader

withForwardUsernameHeader(forwardUsernameHeader)

fn spec.basicAuth.withRealm

withRealm(realm)

fn spec.basicAuth.withStripAuthorizationHeader

withStripAuthorizationHeader(stripAuthorizationHeader)

fn spec.basicAuth.withUsers

withUsers(users)

fn spec.basicAuth.withUsersMixin

withUsersMixin(users)

Note: This function appends passed data to existing values

obj spec.jwt

"AccessControlPolicyJWT configures a JWT access control policy."

fn spec.jwt.withClaims

withClaims(claims)

fn spec.jwt.withForwardHeaders

withForwardHeaders(forwardHeaders)

fn spec.jwt.withForwardHeadersMixin

withForwardHeadersMixin(forwardHeaders)

Note: This function appends passed data to existing values

fn spec.jwt.withJwksFile

withJwksFile(jwksFile)

fn spec.jwt.withJwksUrl

withJwksUrl(jwksUrl)

fn spec.jwt.withPublicKey

withPublicKey(publicKey)

fn spec.jwt.withSigningSecret

withSigningSecret(signingSecret)

fn spec.jwt.withSigningSecretBase64Encoded

withSigningSecretBase64Encoded(signingSecretBase64Encoded)

fn spec.jwt.withStripAuthorizationHeader

withStripAuthorizationHeader(stripAuthorizationHeader)

fn spec.jwt.withTokenQueryKey

withTokenQueryKey(tokenQueryKey)

obj spec.oAuthIntro

"AccessControlOAuthIntro configures an OAuth 2.0 Token Introspection access control policy."

fn spec.oAuthIntro.withClaims

withClaims(claims)

fn spec.oAuthIntro.withForwardHeaders

withForwardHeaders(forwardHeaders)

fn spec.oAuthIntro.withForwardHeadersMixin

withForwardHeadersMixin(forwardHeaders)

Note: This function appends passed data to existing values

obj spec.oAuthIntro.clientConfig

"AccessControlOAuthIntroClientConfig configures the OAuth 2.0 client for issuing token introspection requests."

fn spec.oAuthIntro.clientConfig.withHeaders

withHeaders(headers)

"Headers to set when sending requests to the Authorization Server."

fn spec.oAuthIntro.clientConfig.withHeadersMixin

withHeadersMixin(headers)

"Headers to set when sending requests to the Authorization Server."

Note: This function appends passed data to existing values

fn spec.oAuthIntro.clientConfig.withMaxRetries

withMaxRetries(maxRetries)

"MaxRetries defines the number of retries for introspection requests."

fn spec.oAuthIntro.clientConfig.withTimeoutSeconds

withTimeoutSeconds(timeoutSeconds)

"TimeoutSeconds configures the maximum amount of seconds to wait before giving up on requests."

fn spec.oAuthIntro.clientConfig.withTokenTypeHint

withTokenTypeHint(tokenTypeHint)

"TokenTypeHint is a hint to pass to the Authorization Server.\nSee https://tools.ietf.org/html/rfc7662#section-2.1 for more information."

fn spec.oAuthIntro.clientConfig.withUrl

withUrl(url)

"URL of the Authorization Server."

obj spec.oAuthIntro.clientConfig.tls

"TLS configures TLS communication with the Authorization Server."

fn spec.oAuthIntro.clientConfig.tls.withCa

withCa(ca)

"CA sets the CA bundle used to sign the Authorization Server certificate."

fn spec.oAuthIntro.clientConfig.tls.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"InsecureSkipVerify skips the Authorization Server certificate validation.\nFor testing purposes only, do not use in production."

obj spec.oAuthIntro.tokenSource

"TokenSource describes how to extract tokens from HTTP requests.\nIf multiple sources are set, the order is the following: header > query > cookie."

fn spec.oAuthIntro.tokenSource.withCookie

withCookie(cookie)

"Cookie is the name of a cookie."

fn spec.oAuthIntro.tokenSource.withHeader

withHeader(header)

"Header is the name of a header."

fn spec.oAuthIntro.tokenSource.withHeaderAuthScheme

withHeaderAuthScheme(headerAuthScheme)

"HeaderAuthScheme sets an optional auth scheme when Header is set to \"Authorization\".\nIf set, this scheme is removed from the token, and all requests not including it are dropped."

fn spec.oAuthIntro.tokenSource.withQuery

withQuery(query)

"Query is the name of a query parameter."

obj spec.oidc

"AccessControlPolicyOIDC holds the OIDC authentication configuration."

fn spec.oidc.withAuthParams

withAuthParams(authParams)

fn spec.oidc.withAuthParamsMixin

withAuthParamsMixin(authParams)

Note: This function appends passed data to existing values

fn spec.oidc.withClaims

withClaims(claims)

fn spec.oidc.withClientId

withClientId(clientId)

fn spec.oidc.withDisableAuthRedirectionPaths

withDisableAuthRedirectionPaths(disableAuthRedirectionPaths)

fn spec.oidc.withDisableAuthRedirectionPathsMixin

withDisableAuthRedirectionPathsMixin(disableAuthRedirectionPaths)

Note: This function appends passed data to existing values

fn spec.oidc.withForwardHeaders

withForwardHeaders(forwardHeaders)

fn spec.oidc.withForwardHeadersMixin

withForwardHeadersMixin(forwardHeaders)

Note: This function appends passed data to existing values

fn spec.oidc.withIssuer

withIssuer(issuer)

fn spec.oidc.withLogoutUrl

withLogoutUrl(logoutUrl)

fn spec.oidc.withRedirectUrl

withRedirectUrl(redirectUrl)

fn spec.oidc.withScopes

withScopes(scopes)

fn spec.oidc.withScopesMixin

withScopesMixin(scopes)

Note: This function appends passed data to existing values

obj spec.oidc.secret

"SecretReference represents a Secret Reference. It has enough information to retrieve secret\nin any namespace"

fn spec.oidc.secret.withName

withName(name)

"name is unique within a namespace to reference a secret resource."

fn spec.oidc.secret.withNamespace

withNamespace(namespace)

"namespace defines the space within which the secret name must be unique."

obj spec.oidc.session

"Session holds session configuration."

fn spec.oidc.session.withDomain

withDomain(domain)

fn spec.oidc.session.withPath

withPath(path)

fn spec.oidc.session.withRefresh

withRefresh(refresh)

fn spec.oidc.session.withSameSite

withSameSite(sameSite)

fn spec.oidc.session.withSecure

withSecure(secure)

obj spec.oidc.stateCookie

"StateCookie holds state cookie configuration."

fn spec.oidc.stateCookie.withDomain

withDomain(domain)

fn spec.oidc.stateCookie.withPath

withPath(path)

fn spec.oidc.stateCookie.withSameSite

withSameSite(sameSite)

fn spec.oidc.stateCookie.withSecure

withSecure(secure)

obj spec.oidcGoogle

"AccessControlPolicyOIDCGoogle holds the Google OIDC authentication configuration."

fn spec.oidcGoogle.withAuthParams

withAuthParams(authParams)

fn spec.oidcGoogle.withAuthParamsMixin

withAuthParamsMixin(authParams)

Note: This function appends passed data to existing values

fn spec.oidcGoogle.withClientId

withClientId(clientId)

fn spec.oidcGoogle.withEmails

withEmails(emails)

"Emails are the allowed emails to connect."

fn spec.oidcGoogle.withEmailsMixin

withEmailsMixin(emails)

"Emails are the allowed emails to connect."

Note: This function appends passed data to existing values

fn spec.oidcGoogle.withForwardHeaders

withForwardHeaders(forwardHeaders)

fn spec.oidcGoogle.withForwardHeadersMixin

withForwardHeadersMixin(forwardHeaders)

Note: This function appends passed data to existing values

fn spec.oidcGoogle.withLogoutUrl

withLogoutUrl(logoutUrl)

fn spec.oidcGoogle.withRedirectUrl

withRedirectUrl(redirectUrl)

obj spec.oidcGoogle.secret

"SecretReference represents a Secret Reference. It has enough information to retrieve secret\nin any namespace"

fn spec.oidcGoogle.secret.withName

withName(name)

"name is unique within a namespace to reference a secret resource."

fn spec.oidcGoogle.secret.withNamespace

withNamespace(namespace)

"namespace defines the space within which the secret name must be unique."

obj spec.oidcGoogle.session

"Session holds session configuration."

fn spec.oidcGoogle.session.withDomain

withDomain(domain)

fn spec.oidcGoogle.session.withPath

withPath(path)

fn spec.oidcGoogle.session.withRefresh

withRefresh(refresh)

fn spec.oidcGoogle.session.withSameSite

withSameSite(sameSite)

fn spec.oidcGoogle.session.withSecure

withSecure(secure)

obj spec.oidcGoogle.stateCookie

"StateCookie holds state cookie configuration."

fn spec.oidcGoogle.stateCookie.withDomain

withDomain(domain)

fn spec.oidcGoogle.stateCookie.withPath

withPath(path)

fn spec.oidcGoogle.stateCookie.withSameSite

withSameSite(sameSite)

fn spec.oidcGoogle.stateCookie.withSecure

withSecure(secure)