AppBinding
appcatalog.appscode.com / v1alpha1
apiVersion: appcatalog.appscode.com/v1alpha1
kind: AppBinding
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
AppBindingSpec is the spec for app
appRef object
Reference to underlying application
apiGroup
string
kind
string
name
string required
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
namespace
string
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
clientConfig object required
ClientConfig defines how to communicate with the app. Required
caBundle
string
CABundle is a PEM encoded CA bundle which will be used to validate the serving certificate of this app.
format:
byte
insecureSkipTLSVerify
boolean
InsecureSkipTLSVerify disables TLS certificate verification when communicating with this app. This is strongly discouraged. You should use the CABundle instead.
serverName
string
ServerName is used to verify the hostname on the returned certificates unless InsecureSkipVerify is given. It is also included in the client's handshake to support virtual hosting unless it is an IP address.
service object
`service` is a reference to the service for this app. Either `service` or `url` must be specified.
If the webhook is running within the cluster, then you should use `service`.
name
string required
`name` is the name of the service. Required
namespace
string
`namespace` is the namespace of the service.
path
string
`path` is an optional URL path which will be sent in any request to this service.
port
integer required
The port that will be exposed by this app.
format:
int32
query
string
`query` is optional encoded query string, without '?' which will be sent in any request to this service.
scheme
string required
Specifies which scheme to use, for example: http, https If specified, then it will applied as prefix in this format: scheme:// If not specified, then nothing will be prefixed
url
string
`url` gives the location of the app, in standard URL form (`[scheme://]host:port/path`). Exactly one of `url` or `service` must be specified.
The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address.
A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the app, for example, a cluster identifier.
Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either.
parameters
object
Parameters is a set of the parameters to be used to connect to the app. The inline YAML/JSON payload to be translated into equivalent JSON object.
The Parameters field is NOT secret or secured in any way and should NEVER be used to hold sensitive information. To set parameters that contain secret information, you should ALWAYS store that information in a Secret.
secret object
Secret is the name of the secret to create in the AppBinding's namespace that will hold the credentials associated with the AppBinding.
name
string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
secretTransforms []object
List of transformations that should be applied to the credentials associated with the ServiceBinding before they are inserted into the Secret.
addKey object
AddKey represents a transform that adds an additional key to the credentials Secret
key
string required
The name of the key to add
stringValue
string
The string (non-binary) value to add to the Secret under the specified key.
value
string
The binary value (possibly non-string) to add to the Secret under the specified key. If both value and stringValue are specified, then value is ignored and stringValue is stored.
format:
byteaddKeysFrom object
AddKeysFrom represents a transform that merges all the entries of an existing Secret into the credentials Secret
secretRef object
The reference to the Secret that should be merged into the credentials Secret.
name
string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
removeKey object
RemoveKey represents a transform that removes a credentials Secret entry
key
string required
The key to remove from the Secret
renameKey object
RenameKey represents a transform that renames a credentials Secret entry's key
from
string required
The name of the key to rename
to
string required
The new name for the key
tlsSecret object
TLSSecret is the name of the secret that will hold the client certificate and private key associated with the AppBinding.
name
string
Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
type
string
Type used to facilitate programmatic handling of application.
version
string
Version used to facilitate programmatic handling of application.
No matches. Try .spec.appRef for an exact path