garage

Garage. Provides objectStorage and runs an S3 endpoint; binds http, volume, and secret.

Cluster example

providers.objectStorage = apps.garage.main;
apps.garage.main = {
  region = "home";
};

Provides

objectStorage13 options

• accessKeynull or (submodule)

  Bound secretRef for the access key. Written by the objectStorage provider.

  Default

  null

• accessKey.keystring

  Key inside the Secret.

• accessKey.namestring

  Kubernetes Secret object name.

• accessKey.namespacenull or string

  Namespace of the Secret. Defaults to the namespace of the consumer that reads it.

  Default

  null

• bucketnull or string

  Bucket name. Defaults to the consumer DNS label.

  Default

  null

• endpointnull or string

  Bound S3 endpoint. Written by the objectStorage provider.

  Default

  null

• providernull or (podule provider reference (apps.<type>.<instance> or impl.<contract>.<name>))

  Overrides providers.objectStorage for this need.

  Default

  null

• publicboolean

  Serve the bucket as a website.

  Default

  false

• regionnull or string

  Bound region. Written by the objectStorage provider.

  Default

  null

• secretKeynull or (submodule)

  Bound secretRef for the secret key. Written by the objectStorage provider.

  Default

  null

• secretKey.keystring

  Key inside the Secret.

• secretKey.namestring

  Kubernetes Secret object name.

• secretKey.namespacenull or string

  Namespace of the Secret. Defaults to the namespace of the consumer that reads it.

  Default

  null

Needs

http7 options

• hostnull or string

  Fully qualified host. Defaults to the consumer DNS label under the bound zone.

  Default

  null

• ingressClassNamenull or string

  Bound IngressClass. Written by the http provider.

  Default

  null

• pathPrefixstring

  Path prefix the Ingress routes on.

  Default

  "/"

• portnull or 16 bit unsigned integer; between 0 and 65535 (both inclusive)

  Backend Service port. Defaults to the port the app declares.

  Default

  null

• providernull or (podule provider reference (apps.<type>.<instance> or impl.<contract>.<name>))

  Overrides providers.http for this need.

  Default

  null

• publicUrlnull or string

  Bound public URL, always https. Written by the http provider.

  Default

  null

• tlsSecretNamenull or string

  Bound name of the TLS Secret. Written by the http provider.

  Default

  null

volume5 options

• <name>.accessModeslist of string

  Access modes for the PVC.

  Default

  [ "ReadWriteOnce" ]

• <name>.classnull or string

  Storage class alias, resolved by the volume provider.

  Default

  null

• <name>.pathstring

  Mount path this claim is bound to in the consumer's pod.

• <name>.sizenull or string

  Requested size, such as 10Gi. Defaults to the size the volume provider assigns.

  Default

  null

• providernull or (podule provider reference (apps.<type>.<instance> or impl.<contract>.<name>))

  Overrides providers.volume for this need.

  Default

  null

secret7 options

• <name>.externalboolean

  The operator supplies this value before apply. Other secrets are generated in the cluster.

  Default

  false

• <name>.keyslist of string

  Keys stored in this Secret. Empty means one key named after the secret.

  Default

  [ ]

  Example

  [ "name" "user" "password" ]

• <name>.refnull or (submodule)

  Bound secretRef for this secret. Written by the secret provider.

  Default

  null

• <name>.ref.keystring

  Key inside the Secret.

• <name>.ref.namestring

  Kubernetes Secret object name.

• <name>.ref.namespacenull or string

  Namespace of the Secret. Defaults to the namespace of the consumer that reads it.

  Default

  null

• providernull or (podule provider reference (apps.<type>.<instance> or impl.<contract>.<name>))

  Overrides providers.secret for this need. One provider handles every named secret.

  Default

  null

Instance options

• defaultBucketstring

  Bucket Garage creates for its own use when an instance starts.

  Default

  "static"

• packagepackage

  Garage package.

• regionstring

  S3 region reported to consumers.

  Default

  "garage"