Webhook
generators.external-secrets.io / v1alpha1
apiVersion: generators.external-secrets.io/v1alpha1
kind: Webhook
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
WebhookSpec controls the behavior of the external generator. Any body parameters should be passed to the server through the parameters field.
auth object
Auth specifies a authorization protocol. Only one protocol may be set.
ntlm object
NTLMProtocol configures the store to use NTLM for auth
passwordSecret object required
SecretKeySelector is a reference to a specific 'key' within a Secret resource.
In some instances, `key` is a required field.
key
string
A key in the referenced Secret.
Some instances of this field may be defaulted, in others it may be required.
pattern:
^[-._a-zA-Z0-9]+$minLength:
1maxLength:
253
name
string
The name of the Secret resource being referred to.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$minLength:
1maxLength:
253
namespace
string
The namespace of the Secret resource being referred to.
Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63usernameSecret object required
SecretKeySelector is a reference to a specific 'key' within a Secret resource.
In some instances, `key` is a required field.
key
string
A key in the referenced Secret.
Some instances of this field may be defaulted, in others it may be required.
pattern:
^[-._a-zA-Z0-9]+$minLength:
1maxLength:
253
name
string
The name of the Secret resource being referred to.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$minLength:
1maxLength:
253
namespace
string
The namespace of the Secret resource being referred to.
Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63
body
string
Body
caBundle
string
PEM encoded CA bundle used to validate webhook server certificate. Only used
if the Server URL is using HTTPS protocol. This parameter is ignored for
plain HTTP protocol connection. If not set the system root certificates
are used to validate the TLS connection.
format:
bytecaProvider object
The provider for the CA bundle to use to validate webhook server certificate.
key
string
The key where the CA certificate can be found in the Secret or ConfigMap.
pattern:
^[-._a-zA-Z0-9]+$minLength:
1maxLength:
253
name
string required
The name of the object located at the provider type.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$minLength:
1maxLength:
253
namespace
string
The namespace the Provider type is in.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?$minLength:
1maxLength:
63
type
string required
The type of provider to use such as "Secret", or "ConfigMap".
enum:
Secret, ConfigMap
headers
object
Headers
method
string
Webhook Method
result object required
Result formatting
jsonPath
string
Json path of return value
secrets []object
Secrets to fill in templates
These secrets will be passed to the templating function as key value pairs under the given name
name
string required
Name of this secret in templates
secretRef object required
Secret ref to fill in credentials
key
string
The key where the token is found.
pattern:
^[-._a-zA-Z0-9]+$minLength:
1maxLength:
253
name
string
The name of the Secret resource being referred to.
pattern:
^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$minLength:
1maxLength:
253
timeout
string
Timeout
url
string required
Webhook url to call
No matches. Try .spec.auth for an exact path