rig.dev/v1alpha1

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group

Resource Types

• Capsule

CPUTarget

CPUTarget defines an autoscaler target for the CPU metric If empty, no autoscaling will be done

Appears in:

• HorizontalScale

Field	Description
averageUtilizationPercentage integer	AverageUtilizationPercentage sets the utilization which when exceeded will trigger autoscaling.

Capsule

Capsule is the Schema for the capsules API

Field	Description
apiVersion string	rig.dev/v1alpha1
kind string	Capsule
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec CapsuleSpec	Spec holds the specification of the Capsule.

CapsuleInterface

CapsuleInterface defines an interface for a capsule

Appears in:

• CapsuleSpec

Field	Description
name string	Name specifies a descriptive name of the interface.
port integer	Port specifies what port the interface should have.
public CapsulePublicInterface	Public specifies if and how the interface should be published.

CapsuleInterfaceIngress

CapsuleInterfaceIngress defines that the interface should be exposed as http ingress

Appears in:

• CapsulePublicInterface

Field	Description
host string	Host specifies the DNS name of the Ingress resource

CapsuleInterfaceLoadBalancer

CapsuleInterfaceLoadBalancer defines that the interface should be exposed as a L4 loadbalancer

Appears in:

• CapsulePublicInterface

Field	Description
port integer	Port is the external port on the LoadBalancer
nodePort integer	NodePort specifies a NodePort that the Service will use instead of acting as a LoadBalancer.

CapsulePublicInterface

CapsulePublicInterface defines how to publicly expose the interface

Appears in:

• CapsuleInterface

Field	Description
ingress CapsuleInterfaceIngress	Ingress specifies that this interface should be exposed through an Ingress resource. The Ingress field is mutually exclusive with the LoadBalancer field.
loadBalancer CapsuleInterfaceLoadBalancer	LoadBalancer specifies that this interface should be exposed through a LoadBalancer Service. The LoadBalancer field is mutually exclusive with the Ingress field.

CapsuleSpec

CapsuleSpec defines the desired state of Capsule

Appears in:

• Capsule

Field	Description
replicas integer	Replicas specifies how many replicas the Capsule should have.
image string	Image specifies what image the Capsule should run.
command string	Command is run as a command in the shell. If left unspecified, the container will run using what is specified as ENTRYPOINT in the Dockerfile.
args string array	Args is a list of arguments either passed to the Command or if Command is left empty the arguments will be passed to the ENTRYPOINT of the docker image.
interfaces CapsuleInterface array	Interfaces specifies the list of interfaces the the container should have. Specifying interfaces will create the corresponding kubernetes Services and Ingresses depending on how the interface is configured.
env Env	Env specifies configuration for how the container should obtain environment variables.
files File array	Files is a list of files to mount in the container. These can either be based on ConfigMaps or Secrets.
resources ResourceRequirements	Resources describes what resources the Capsule should have access to.
imagePullSecret LocalObjectReference	ImagePullSecret is a reference to a secret holding docker credentials for the registry of the image.
horizontalScale HorizontalScale	HorizontalScale describes how the Capsule should scale out
serviceAccountName string	ServiceAccountName specifies the name of an existing ServiceAccount which the Capsule should run as.
nodeSelector object (keys:string, values:string)	NodeSelector is a selector for what nodes the Capsule should live on.

Env

Env defines what secrets and configmaps should be used for environment variables in the capsule.

Appears in:

• CapsuleSpec

Field	Description
automatic boolean	Automatic sets wether the capsule should automatically use existing secrets and configmaps which share the same name as the capsule as environment variables.
from EnvSource array	From holds a list of references to secrets and configmaps which should be mounted as environment variables.

EnvSource

EnvSource holds a reference to either a ConfigMap or a Secret

Appears in:

• Env

Field	Description
configMapName string	ConfigMapName is the name of a ConfigMap in the same namespace as the Capsule
secretName string	SecretName is the name of a Secret in the same namespace as the Capsule

File

File defines a mounted file and where to retrieve the contents from

Appears in:

• CapsuleSpec

Field	Description
path string	Path specifies the full path where the File should be mounted including the file name.
configMap FileContentRef	ConfigMap specifies that this file is based on a key in a ConfigMap. The ConfigMap field is mutually exclusive with Secret.
secret FileContentRef	Secret specifies that this file is based on a key in a Secret. The Secret field is mutually exclusive with ConfigMap.

FileContentRef

FileContentRef defines the name of a config resource and the key from which to retrieve the contents

Appears in:

• File

Field	Description
name string	Name specifies the name of the Secret or ConfigMap.
key string	Key specifies the key holding the file contents.

HorizontalScale

HorizontalScale defines the policy for the number of replicas of the capsule It can both be configured with autoscaling and with a static number of replicas

Appears in:

• CapsuleSpec

Field	Description
minReplicas integer	MinReplicas is the minimum amount of replicas that the Capsule should have.
maxReplicas integer	MaxReplicas is the maximum amount of replicas that the Capsule should have.
cpuTarget CPUTarget	CPUTarget specifies that this Capsule should be scaled using CPU utilization.

---

generated from source code

This page is generated based on go source code. If you have suggestions for improvements for this page, please open an issue at github.com/rigdev/rig, or a pull request with changes to the go source files.