API Reference

Packages:

admin.rio.cattle.io/v1

Resource Types:

ClusterDomain

Field Description
apiVersion
string		 admin.rio.cattle.io/v1
kind
string 		ClusterDomain
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ClusterDomainSpec

secretName
string

SecretName holding the TLS certificate for this domain. This is expected to be a wildcard certificate
httpsPort
int

The public HTTPS port for the cluster domain
httpPort
int

The public HTTP port for the cluster domain
addresses
[]Address

The addresses assigned to the ClusterDomain by the provider
status
ClusterDomainStatus

PublicDomain

PublicDomain is a top-level resource which allows a user to access its own public domain for the services inside cluster. It can be pointed to a Router or a Service. It is the user’s responsibility to setup a CNAME or A record to the clusterDomain or ingress IP.

Field Description
apiVersion
string		 admin.rio.cattle.io/v1
kind
string 		PublicDomain
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
PublicDomainSpec

secretName
string

SecretName holding the TLS certificate for this domain.
targetApp
string

Target App Name. Only TargetAppName or TargetRouter can be set
targetRouter
string

Target Router Name. Only TargetAppName or TargetRouter can be set
targetVersion
string

Target Version
targetNamespace
string

Target Service or Router Namespace
status
PublicDomainStatus

RioInfo

Field Description
apiVersion
string		 admin.rio.cattle.io/v1
kind
string 		RioInfo
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
status
RioInfoStatus

SystemStack

Field Description
apiVersion
string		 admin.rio.cattle.io/v1
kind
string 		SystemStack
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.

Address

(Appears on: ClusterDomainSpec)

Field Description
ip
string
hostname
string

ClusterDomainSpec

(Appears on: ClusterDomain)

Field Description
secretName
string

SecretName holding the TLS certificate for this domain. This is expected to be a wildcard certificate
httpsPort
int

The public HTTPS port for the cluster domain
httpPort
int

The public HTTP port for the cluster domain
addresses
[]Address

The addresses assigned to the ClusterDomain by the provider

ClusterDomainStatus

(Appears on: ClusterDomain)

Field Description
assignedSecretName
string
httpsSupported
bool
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

PublicDomainSpec

(Appears on: PublicDomain)

Field Description
secretName
string

SecretName holding the TLS certificate for this domain.
targetApp
string

Target App Name. Only TargetAppName or TargetRouter can be set
targetRouter
string

Target Router Name. Only TargetAppName or TargetRouter can be set
targetVersion
string

Target Version
targetNamespace
string

Target Service or Router Namespace

PublicDomainStatus

(Appears on: PublicDomain)

Field Description
httpsSupported
bool

Whether HTTP is supported in the Domain
assignedSecretName
string

Secret containing TLS cert for HTTPS
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

Represents the latest available observations of a PublicDomain’s current state.

RioInfoStatus

(Appears on: RioInfo)

Field Description
version
string
gitCommit
string
systemNamespace
string
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition
systemComponentReadyMap
map[string]string

management.cattle.io/v3

Resource Types:

Setting

Field Description
apiVersion
string		 management.cattle.io/v3
kind
string 		Setting
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
value
string
default
string
customized
bool
source
string

User

Field Description
apiVersion
string		 management.cattle.io/v3
kind
string 		User
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
displayName
string
description
string
username
string
password
string
mustChangePassword
bool
principalIds
[]string
me
bool
enabled
bool
spec
UserSpec

status
UserStatus

UserSpec

(Appears on: User)

UserStatus

(Appears on: User)

Field Description
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

rio.cattle.io/v1

Resource Types:

ExternalService

ExternalService creates a DNS record and route rules for any Service outside of the cluster, can be IPs or FQDN outside the mesh

Field Description
apiVersion
string		 rio.cattle.io/v1
kind
string 		ExternalService
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ExternalServiceSpec

ipAddresses
[]string

External service located outside the mesh, represented by IPs
fqdn
string

External service located outside the mesh, represented by DNS
targetApp
string

In-Mesh app in another namespace
targetVersion
string

In-Mesh version in another namespace
targetRouter
string

In-Mesh router in another namespace
targetServiceNamespace
string

Namespace of in-mesh service in another namespace
status
ExternalServiceStatus

Router

Router is a top level resource to create L7 routing to different services. It will create VirtualService, ServiceEntry and DestinationRules

Field Description
apiVersion
string		 rio.cattle.io/v1
kind
string 		Router
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
RouterSpec

routes
[]RouteSpec

An ordered list of route rules for HTTP traffic. The first rule matching an incoming request is used.
internal
bool

By default all Routers are public and exposed outside of the cluster. Setting internal to true will cause the Router to not be exposed
status
RouterStatus

Service

Service acts as a top level resource for a container and its sidecars and routing resources. Each service represents an individual revision, grouped by Spec.App(defaults to Service.Name), and Spec.Version(defaults to v0)

Field Description
apiVersion
string		 rio.cattle.io/v1
kind
string 		Service
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ServiceSpec

PodConfig
PodConfig
template
bool

This service is a template for new versions to be created based on changes from the build.repo
stageOnly
bool

Whether to only stage services that are generated through the template from build.repo
version
string

Version of this service
app
string

The exposed app name, if no value is set, then metadata.name of the Service is used
weight
int

The weight among services with matching app field to determine how much traffic is load balanced to this service. If rollout is set, the weight becomes the target weight of the rollout.
replicas
int

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1 in deployment.
maxUnavailable
k8s.io/apimachinery/pkg/util/intstr.IntOrString 		(Optional)

The maximum number of pods that can be unavailable during the update. The value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). An absolute number is calculated from percentage by rounding down. This cannot be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, the old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
maxSurge
k8s.io/apimachinery/pkg/util/intstr.IntOrString 		(Optional)

The maximum number of pods that can be scheduled above the desired number of pods. The value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. An absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once the old pods have been killed, the new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
autoscale
AutoscaleConfig

Autoscale the replicas based on the amount of traffic received by this service
rollout
RolloutConfig

RolloutConfig controls how each service is allocated ComputedWeight
global
bool

Place one pod per node that matches the scheduling rules
serviceMesh
bool

Whether to disable Service mesh for the Service. If true, no mesh sidecar will be deployed along with the Service
requestTimeoutSeconds
int

RequestTimeoutSeconds specifies the timeout set on api gateway for each individual service
permissions
[]Permission

Permissions to the Services. It will create corresponding ServiceAccounts, Roles and RoleBinding.
globalPermissions
[]Permission

GlobalPermissions to the Services. It will create corresponding ServiceAccounts, ClusterRoles and ClusterRoleBinding.
status
ServiceStatus

Stack

Field Description
apiVersion
string		 rio.cattle.io/v1
kind
string 		Stack
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
StackSpec

build
StackBuild

Stack build parameters that watches git repo
permissions
[]Permission

Permissions used while deploying objects created by this stack
additionalGroupVersionKinds
[]k8s.io/apimachinery/pkg/runtime/schema.GroupVersionKind

Additional GVKs not in the rio.cattle.io that have the rio.cattle.io/stack label. These objects are “owned” by this stack
answers
map[string]string

Stack answers
status
StackStatus

AutoscaleConfig

(Appears on: ServiceSpec)

Field Description
concurrency
int

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Defaults to 0 which means unlimited concurrency.
minReplicas
int32

The minimal number of replicas Service can be scaled
maxReplicas
int32

The maximum number of replicas Service can be scaled

BuildRevision

(Appears on: ServiceStatus)

Field Description
commits
[]string

Container

(Appears on: NamedContainer, PodConfig)

Field Description
image
string

Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
build
ImageBuildSpec

ImageBuild specifies how to build this image
command
[]string

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
args
[]string

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
workingDir
string

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
ports
[]ContainerPort

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Cannot be updated.
env
[]EnvVar

List of environment variables to set in the container. Cannot be updated.
cpuMillis
int64

CPU, in milliCPU (e.g. 500 = .5 CPU cores)
memoryBytes
int64

Memory, in bytes
secrets
[]DataMount

Secrets Mounts
configs
[]DataMount

Configmaps Mounts
livenessProbe
Kubernetes core/v1.Probe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe
Kubernetes core/v1.Probe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
imagePullPolicy
Kubernetes core/v1.PullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if tag is does not start with v[0-9] or [0-9], or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
stdin
bool

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce
bool

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
tty
bool

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.
volumes
[]Volume

Pod volumes to mount into the container’s filesystem
ContainerSecurityContext
ContainerSecurityContext

ContainerPort

(Appears on: Container)

Field Description
name
string
expose
bool

Expose will make the port available outside the cluster. All http/https ports will be set to true by default if Expose is nil. All other protocols are set to false by default
protocol
Protocol
port
int32
targetPort
int32
hostport
bool

ContainerSecurityContext

(Appears on: Container)

ContainerSecurityContext holds pod-level security attributes and common container constants. Optional: Defaults to empty. See type description for default values of each field.

Field Description
runAsUser
int64

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container
runAsGroup
int64

The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.
readOnlyRootFilesystem
bool

Whether this container has a read-only root filesystem. Default is false.
privileged
bool 		(Optional)

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

DNS

(Appears on: PodConfig)

Field Description
policy
Kubernetes core/v1.DNSPolicy

Set DNS policy for the pod. Defaults to “ClusterFirst”. Valid values are ‘ClusterFirstWithHostNet’, ‘ClusterFirst’, ‘Default’ or ‘None’. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to ‘ClusterFirstWithHostNet’.
nameservers
[]string

A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
searches
[]string

A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.
options
[]PodDNSConfigOption

A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy.

DataMount

(Appears on: Container)

Field Description
target
string

The directory or file to mount the value to in the container
name
string

The name of the ConfigMap or Secret to mount
key
string

The key in the data of the ConfigMap or Secret to mount to a file. If Key is set the Target must be a file. If key is set the target must be a directory and will contain one file per key from the Secret/ConfigMap data field.

Destination

(Appears on: RouteSpec, WeightedDestination)

Field Description
app
string

Destination Service
version
string

Destination Revision
port
uint32

Destination Port

EnvVar

(Appears on: Container)

Field Description
name
string
value
string
secretName
string
configMapName
string
key
string

ExternalServiceSpec

(Appears on: ExternalService)

Field Description
ipAddresses
[]string

External service located outside the mesh, represented by IPs
fqdn
string

External service located outside the mesh, represented by DNS
targetApp
string

In-Mesh app in another namespace
targetVersion
string

In-Mesh version in another namespace
targetRouter
string

In-Mesh router in another namespace
targetServiceNamespace
string

Namespace of in-mesh service in another namespace

ExternalServiceStatus

(Appears on: ExternalService)

Field Description
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

Represents the latest available observations of a ExternalService’s current state.

Fault

(Appears on: RouteSpec)

Field Description
percentage
int

Percentage of requests on which the delay will be injected.
delayMillis
int

REQUIRED. Add a fixed delay before forwarding the request. Units: milliseconds
abortHTTPStatus
int

Abort Http request attempts and return error codes back to downstream service, giving the impression that the upstream service is faulty.

HeaderMatch

(Appears on: Match)

Field Description
name
string
value
StringMatch

HeaderOperations

(Appears on: RouteSpec)

HeaderOperations Describes the header manipulations to apply

Field Description
add
[]NameValue

Append the given values to the headers specified by keys (will create a comma-separated list of values)
set
[]NameValue

Append the given values to the headers specified by keys (will create a comma-separated list of values)
remove
[]string

Remove a the specified headers

ImageBuildSpec

(Appears on: Container)

Field Description
repo
string

Repository url
revision
string

Repo Revision. Can be a git commit or tag
branch
string

Repo Branch. If specified, a gitmodule will be created to watch the repo and creating new revision if new commit or tag is pushed.
dockerfile
string

Specify the name of the Dockerfile in the Repo. This is the full path relative to the repo root. Defaults to Dockerfile.
context
string

Specify build context. Defaults to “.”
args
[]string

Specify build args
template
string

Specify the build template. Defaults to buildkit.
webhookSecretName
string

Specify the github secret name. Used to create Github webhook, the secret key has to be accessToken
cloneSecretName
string

Specify secret name for checking our git resources
pushRegistry
string

Specify custom registry to push the image instead of built-in one
pushRegistrySecretName
string

Specify secret for pushing to custom registry
imageName
string

Specify image name instead of the one generated from service name, format: $registry/$imageName:$revision
pr
bool

Whether to enable builds for pull requests
tag
bool

Whether to enable builds for tags
noCache
bool

Build image with no cache
timeout
int

TimeoutSeconds describes how long the build can run

Match

(Appears on: RouteSpec)

Field Description
path
StringMatch

URI to match values are case-sensitive and formatted as follows:

exact: “value” for exact string match

prefix: “value” for prefix-based match

regex: “value” for ECMAscript style regex-based match
methods
[]string

HTTP Method values are case-sensitive and formatted as follows:

exact: “value” for exact string match

prefix: “value” for prefix-based match

regex: “value” for ECMAscript style regex-based match
headers
[]HeaderMatch

The header keys must be lowercase and use hyphen as the separator, e.g. x-request-id.

Header values are case-sensitive and formatted as follows:

exact: “value” for exact string match

prefix: “value” for prefix-based match

regex: “value” for ECMAscript style regex-based match

Note: The keys uri, scheme, method, and authority will be ignored.

NameValue

(Appears on: HeaderOperations)

Field Description
name
string
value
string

NamedContainer

(Appears on: PodConfig)

Field Description
name
string

The name of the container
init
bool

List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
Container
Container

Permission

(Appears on: ServiceSpec, StackSpec)

Field Description
role
string
verbs
[]string
apiGroup
string
resource
string
url
string
resourceName
string

PodConfig

(Appears on: ServiceSpec)

Field Description
containers
[]NamedContainer

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
hostname
string

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.
hostAliases
[]Kubernetes core/v1.HostAlias

HostAliases is an optional list of hosts and IPs that will be injected into the pod’s hosts file if specified. This is only valid for non-hostNetwork pods.
hostNetwork
bool

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.
imagePullSecrets
[]string

Image pull secret
volumeTemplates
[]VolumeTemplate

Volumes to create per replica
dns
DNS

DNS settings for this Pod
Affinity
Kubernetes core/v1.Affinity

(Members of Affinity are embedded into this type.)

Container
Container

PodDNSConfigOption

(Appears on: DNS)

Field Description
name
string
value
string

Protocol (string alias)

(Appears on: ContainerPort)

Question

(Appears on: TemplateMeta)

Field Description
variable
string

The variable name to reference using ${…} syntax
label
string

A friend name for the question
description
string

A longer description of the question
type
string

The field type: string, int, bool, enum. default is string
required
bool

The answer can not be blank
default
string

Default value of the answer if not specified by the user
group
string

Group the question with questions in the same group (Most used by UI)
minLength
int

Minimum length of the answer
maxLength
int

Maximum length of the answer
min
int

Minimum value of an int answer
max
int

Maximum value of an int answer
options
[]string

An array of valid answers for type enum questions
validChars
string

Answer must be composed of only these characters
invalidChars
string

Answer must not have any of these characters
subquestions
[]SubQuestion

A list of questions that are considered child questions
showIf
string

Ask question only if this evaluates to true, more info on syntax below
showSubquestionIf
string

Ask subquestions if this evaluates to true

Redirect

(Appears on: RouteSpec)

Field Description
host
string
path
string
prefix
string
toHTTPS
bool

Retry

(Appears on: RouteSpec)

Field Description
timeoutSeconds
int
attempts
int

Rewrite

(Appears on: RouteSpec)

Field Description
host
string
path
string

RolloutConfig

(Appears on: ServiceSpec)

RolloutConfig specifies the configuration when promoting a new revision

Field Description
increment
int

Increment Value each Rollout can scale up or down, always a positive number
intervalSeconds
int

Interval between each Rollout in seconds
pause
bool

Pause if true the rollout will stop in place until set to false.

RouteSpec

(Appears on: RouterSpec)

Field Description
match
Match

Match conditions to be satisfied for the rule to be activated. All conditions inside a single match block have AND semantics, while the list of match blocks have OR semantics. The rule is matched if any one of the match blocks succeed.
to
[]WeightedDestination

An http rule can either redirect or forward (default) traffic. The forwarding target can be one of several versions of a service (see glossary in beginning of document). Weights associated with the service version determine the proportion of traffic it receives.
redirect
Redirect

An http rule can either redirect or forward (default) traffic. If traffic passthrough option is specified in the rule, route/redirect will be ignored. The redirect primitive can be used to send a HTTP 301 redirect to a different URI or Authority.
rewrite
Rewrite

Rewrite HTTP URIs and Authority headers. Rewrite cannot be used with Redirect primitive. Rewrite will be performed before forwarding.
retry
Retry

Retries specifies the retry logic for each route
headers
HeaderOperations

Header manipulation rules
fault
Fault

Fault injection policy to apply on HTTP traffic at the client side. Note that timeouts or retries will not be enabled when faults are enabled on the client side.
mirror
Destination

Mirror HTTP traffic to a another destination in addition to forwarding the requests to the intended destination. Mirrored traffic is on a best effort basis where the sidecar/gateway will not wait for the mirrored cluster to respond before returning the response from the original destination. Statistics will be generated for the mirrored destination.
timeoutSeconds
int

TimeoutSeconds specifies timeout setting for each route

RouterSpec

(Appears on: Router)

Field Description
routes
[]RouteSpec

An ordered list of route rules for HTTP traffic. The first rule matching an incoming request is used.
internal
bool

By default all Routers are public and exposed outside of the cluster. Setting internal to true will cause the Router to not be exposed

RouterStatus

(Appears on: Router)

Field Description
endpoints
[]string

The endpoint to access the router
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

Represents the latest available observations of a PublicDomain’s current state.

ScaleStatus

(Appears on: ServiceStatus)

Field Description
unavailable
int

Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created.
available
int

Total number of available pods (ready for at least minReadySeconds) targeted by this deployment.

ServiceSpec

(Appears on: Service)

ServiceSpec represents spec for Service

Field Description
PodConfig
PodConfig
template
bool

This service is a template for new versions to be created based on changes from the build.repo
stageOnly
bool

Whether to only stage services that are generated through the template from build.repo
version
string

Version of this service
app
string

The exposed app name, if no value is set, then metadata.name of the Service is used
weight
int

The weight among services with matching app field to determine how much traffic is load balanced to this service. If rollout is set, the weight becomes the target weight of the rollout.
replicas
int

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1 in deployment.
maxUnavailable
k8s.io/apimachinery/pkg/util/intstr.IntOrString 		(Optional)

The maximum number of pods that can be unavailable during the update. The value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). An absolute number is calculated from percentage by rounding down. This cannot be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, the old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.
maxSurge
k8s.io/apimachinery/pkg/util/intstr.IntOrString 		(Optional)

The maximum number of pods that can be scheduled above the desired number of pods. The value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. An absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once the old pods have been killed, the new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.
autoscale
AutoscaleConfig

Autoscale the replicas based on the amount of traffic received by this service
rollout
RolloutConfig

RolloutConfig controls how each service is allocated ComputedWeight
global
bool

Place one pod per node that matches the scheduling rules
serviceMesh
bool

Whether to disable Service mesh for the Service. If true, no mesh sidecar will be deployed along with the Service
requestTimeoutSeconds
int

RequestTimeoutSeconds specifies the timeout set on api gateway for each individual service
permissions
[]Permission

Permissions to the Services. It will create corresponding ServiceAccounts, Roles and RoleBinding.
globalPermissions
[]Permission

GlobalPermissions to the Services. It will create corresponding ServiceAccounts, ClusterRoles and ClusterRoleBinding.

ServiceStatus

(Appears on: Service)

Field Description
deploymentReady
bool

DeploymentReady for ready status on deployment
scaleStatus
ScaleStatus

ScaleStatus for the Service
computedApp
string

ComputedApp is the calculated value of Spec.App if not set
computedVersion
string

ComputedVersion is the calculated value of Spec.Version if not set
computedReplicas
int

ComputedReplicas is calculated from autoscaling component to make sure pod has the desired load
computedWeight
int

ComputedWeight is the weight calculated from the rollout revision
containerRevision
map[string]github.com/rancher/rio/pkg/apis/rio.cattle.io/v1.BuildRevision

ContainerRevision are populated from builds to store commits for each repo
generatedServices
map[string]bool

GeneratedServices contains all the service names are generated from build template
gitCommits
[]string

GitCommits contains all git commits that triggers template update
shouldGenerate
string

ShouldGenerate contains the serviceName that should be generated on the next controller run
shouldClean
map[string]bool

ShouldClean contains all the services that are generated from template but should be cleaned up.
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

Represents the latest available observations of a deployment’s current state.
endpoints
[]string

The Endpoints to access this version directly
appEndpoints
[]string

The Endpoints to access this service as part of an app
buildLogToken
string

log token to access build log
watch
bool

Watch represents if a service should creates git watcher to watch git changes

StackBuild

(Appears on: StackSpec)

Field Description
repo
string

Git repo url
branch
string

Git branch
revision
string

Git revision
cloneSecretName
string

Git secret name for repository
rioFile
string

Specify the name of the Riofile in the Repo. This is the full path relative to the repo root. Defaults to Riofile.
webhookSecretName
string

Specify the github secret name. Used to create Github webhook, the secret key has to be accessToken

StackSpec

(Appears on: Stack)

Field Description
build
StackBuild

Stack build parameters that watches git repo
permissions
[]Permission

Permissions used while deploying objects created by this stack
additionalGroupVersionKinds
[]k8s.io/apimachinery/pkg/runtime/schema.GroupVersionKind

Additional GVKs not in the rio.cattle.io that have the rio.cattle.io/stack label. These objects are “owned” by this stack
answers
map[string]string

Stack answers

StackStatus

(Appears on: Stack)

Field Description
revision
string

Observed commit for the build
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

StringMatch

(Appears on: HeaderMatch, Match)

Field Description
exact
string
prefix
string
regexp
string

SubQuestion

(Appears on: Question)

Field Description
variable
string
label
string
description
string
type
string
required
bool
default
string
group
string
minLength
int
maxLength
int
min
int
max
int
options
[]string
validChars
string
invalidChars
string
showIf
string

TemplateMeta

Field Description
name
string
version
string
iconUrl
string
readme
string
questions
[]Question
goTemplate
bool
envSubst
bool

Volume

(Appears on: Container)

Field Description
name
string

Name is the name of the volume. If multiple Volumes in the same pod share the same name they will be the same underlying storage. If persistent is set to true Name is required and will be used to reference a PersistentVolumeClaim in the current namespace.

If Name matches the name of a VolumeTemplate on this service then the VolumeTemplate will be used as the source of the volume.
path
string

That path within the container to mount the volume to
hostpath
string

That path on the host to mount into this container
hostPathType
Kubernetes core/v1.HostPathType

HostPathType specify HostPath type
persistent
bool

If Persistent is true then this volume refers to a PersistentVolumeClaim in this namespace. The Name field is used to reference PersistentVolumeClaim. If the Name of this Volume matches a VolumeTemplate then Persistent is assumed to be true

VolumeTemplate

(Appears on: PodConfig)

Field Description
labels
map[string]string

Labels to be applied to the created PVC
annotations
map[string]string

Annotations to be applied to the created PVC
Name
string

Name of the VolumeTemplate. A volume entry will use this name to refer to the created volume
accessModes
[]Kubernetes core/v1.PersistentVolumeAccessMode 		(Optional)

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
storage
int64 		(Optional)

Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
storageClassName
string

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeMode
Kubernetes core/v1.PersistentVolumeMode 		(Optional)

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.

WeightedDestination

(Appears on: RouteSpec)

Field Description
Destination
Destination
weight
int

Weight for the Destination

Generated with gen-crd-api-reference-docs on git commit d9b7db62e.