Skip to content

Latest commit

 

History

History
4750 lines (4750 loc) · 69.6 KB

api-docs.md

File metadata and controls

4750 lines (4750 loc) · 69.6 KB
Raw

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

secretRef
Kubernetes core/v1.SecretReference
addresses
[]Address
subdomains
[]Subdomain
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition
status
ClusterDomainStatus

Feature

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

description
string
enable
bool
questions
[]Question
answers
map[string]string
features
[]string
status
FeatureStatus

PublicDomain

PublicDomain is a top-level resource to allow user to its own public domain for the services inside cluster. It can be pointed to Router or Service. It is 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

(Members of spec are embedded into this type.)



secretRef
Kubernetes core/v1.SecretReference 		SecretRef reference the secret that contains key and certs for TLS configuration. By default it is configured to use Letsencrypt
disableLetsencrypt
bool 		Whether to disable Letsencrypt certificates.
targetServiceName
string 		Target Service Name in the same Namespace
domainName
string 		PublicDomain name
status
PublicDomainStatus

(Members of status are embedded into this type.)

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

Address

(Appears on: ClusterDomainSpec, Subdomain)

Field Description
ip
string

ClusterDomainSpec

(Appears on: ClusterDomain)

Field Description
secretRef
Kubernetes core/v1.SecretReference
addresses
[]Address
subdomains
[]Subdomain
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition

ClusterDomainStatus

(Appears on: ClusterDomain)

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

FeatureSpec

(Appears on: Feature)

Field Description
description
string
enable
bool
questions
[]Question
answers
map[string]string
features
[]string

FeatureStatus

(Appears on: Feature)

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

PublicDomainSpec

(Appears on: PublicDomain)

Field Description
secretRef
Kubernetes core/v1.SecretReference 		SecretRef reference the secret that contains key and certs for TLS configuration. By default it is configured to use Letsencrypt
disableLetsencrypt
bool 		Whether to disable Letsencrypt certificates.
targetServiceName
string 		Target Service Name in the same Namespace
domainName
string 		PublicDomain name

PublicDomainStatus

(Appears on: PublicDomain)

Field Description
httpsSupported
bool 		Whether HTTP is supported in the Domain
endpoint
string 		Endpoint to access this Domain
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

Subdomain

(Appears on: ClusterDomainSpec)

Field Description
name
string
addresses
[]Address

autoscale.rio.cattle.io/v1

Resource Types:

ServiceScaleRecommendation

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

replicas
int32
selector
Kubernetes meta/v1.LabelSelector
status
ServiceScaleRecommendationStatus

ServiceScaleRecommendationSpec

(Appears on: ServiceScaleRecommendation)

Field Description
replicas
int32
selector
Kubernetes meta/v1.LabelSelector

ServiceScaleRecommendationStatus

(Appears on: ServiceScaleRecommendation)

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

rio.cattle.io/v1

Resource Types:

App

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

revisions
[]Revision
status
AppStatus

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 mesh, represented by IPs
fqdn
string 		External service located outside mesh, represented by DNS
service
string 		In-Mesh service name 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.
status
RouterStatus

Service

Service acts as a top level resource for a container and its sidecarsm and routing resources. Each service represents an individual revision, group 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

ServiceScale
ServiceScale
ServiceRevision
ServiceRevision
AutoscaleConfig
AutoscaleConfig
RolloutConfig
RolloutConfig
PodConfig
PodConfig
disableServiceMesh
bool 		Whether to disable ServiceMesh for Service. If true, no mesh sidecar will be deployed along with the 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.
systemSpec
SystemServiceSpec
status
ServiceStatus

Abort

(Appears on: Fault)

Field Description
httpStatus
int 		REQUIRED. HTTP status code to use to abort the Http request.

AppSpec

(Appears on: App)

Field Description
revisions
[]Revision

AppStatus

(Appears on: App)

Field Description
publicDomains
[]string
endpoints
[]string
conditions
[]github.com/rancher/wrangler/pkg/genericcondition.GenericCondition
revisionWeight
map[string]github.com/rancher/rio/pkg/apis/rio.cattle.io/v1.ServiceObservedWeight

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. This field replaces ConcurrencyModel. A value of 1 is equivalent to Single and 0 is equivalent to Multi.
minScale
int 		The minimal scale Service can be scaled
maxScale
int 		The maximum scale Service can be scaled

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
ImageBuild 		ImageBuild Specify the build parameter
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.
cpus
k8s.io/apimachinery/pkg/api/resource.Quantity 		CPU, in cores. (500m = .5 cores)
memory
k8s.io/apimachinery/pkg/api/resource.Quantity 		Memory, in bytes. (500Gi = 500GiB = 500 * 1024 * 1024 * 1024)
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 :latest tag is specified, 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. Cannot be updated.
ContainerSecurityContext
ContainerSecurityContext

ContainerPort

(Appears on: Container)

Field Description
name
string
internalOnly
bool
protocol
Protocol
port
int32
targetPort
int32

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.

DataMount

(Appears on: Container)

Field Description
directory
string
name
string
file
string
key
string

Destination

(Appears on: RouteTraffic, WeightedDestination)

Field Description
service
string 		Destination Service
namespace
string 		Destination Namespace
revision
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 mesh, represented by IPs
fqdn
string 		External service located outside mesh, represented by DNS
service
string 		In-Mesh service name 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: RouteTraffic)

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
abort
Abort 		Abort Http request attempts and return error codes back to downstream service, giving the impression that the upstream service is faulty.

ImageBuild

(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.
stageOnly
bool 		Whether to only stage the new revision. If true, the new created service will not be allocating any traffic automatically.
dockerFile
string 		Specify the name Of the Dockerfile in the Repo. Defaults to `Dockerfile`.
buildContext
string 		Specify build context
template
string 		Specify the build template. Defaults to `buildkit`.
githubSecretName
string 		Specify the github secret name. Used to create Github webhook, the secret key has to be `accessToken`
gitSecretName
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
buildImageName
string 		Specify image name instead of the one generated from service name, format: $registry/$imageName:$revision
enablePr
bool 		Whether to enable builds for pull requests

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
scheme
StringMatch 		URI Scheme 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
method
StringMatch 		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
map[string]github.com/rancher/rio/pkg/apis/rio.cattle.io/v1.StringMatch 		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.
cookies
map[string]github.com/rancher/rio/pkg/apis/rio.cattle.io/v1.StringMatch 		Cookies 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.
port
int 		Specifies the ports on the host that is being addressed. Many services only expose a single port or label ports with the protocols they support, in these cases it is not required to explicitly select the port.
from
ServiceSource

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)

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.
dnsPolicy
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'.
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.
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference 		Image pull secret
Affinity
Kubernetes core/v1.Affinity
PodDNSConfig
PodDNSConfig
Container
Container

PodDNSConfig

(Appears on: PodConfig)

PodDNSConfig Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

Field Description
dnsNameservers
[]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.
dnsSearches
[]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.
dnsOptions
[]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.

PodDNSConfigOption

(Appears on: PodDNSConfig)

Field Description
name
string
value
string

Protocol (string alias)

(Appears on: ContainerPort)

Question

(Appears on: FeatureSpec, 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

Retry

(Appears on: RouteTraffic)

Field Description
attempts
int 		REQUIRED. Number of retries for a given request. The interval between retries will be determined automatically (25ms+). Actual number of retries attempted depends on the httpReqTimeout.
timeoutMillis
int 		Timeout per retry attempt for a given request. Units: milliseconds

Revision

(Appears on: AppSpec)

Field Description
public
bool
serviceName
string
Version
string
adjustedWeight
int
weight
int
scale
int
scaleStatus
ScaleStatus
deploymentReady
bool
RolloutConfig
RolloutConfig

Rewrite

(Appears on: RouteSpec)

Field Description
host
string
path
string

RolloutConfig

(Appears on: Revision, ServiceSpec)

RolloutConfig specifies the configuration when promoting a new revision

Field Description
rollout
bool 		Whether to turn on Rollout(changing the weight gradually)
rolloutIncrement
int 		Increment Value each Rollout can scale up or down
rolloutInterval
int 		Increment Interval between each Rollout

RouteSpec

(Appears on: RouterSpec)

Field Description
matches
[]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 		A 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 		A 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.
headers
github.com/knative/pkg/apis/istio/v1alpha3.HeaderOperations 		Header manipulation rules
RouteTraffic
RouteTraffic

RouteTraffic

(Appears on: RouteSpec)

Field Description
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.
timeoutMillis
int 		Timeout for HTTP requests.
retry
Retry 		Retry policy for HTTP requests.

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.

RouterStatus

(Appears on: Router)

Field Description
publicDomains
[]string 		The list of publicedomains pointing to the router
endpoint
[]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: Revision, ServiceStatus)

Field Description
ready
int 		Total number of ready pods targeted by this deployment.
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.
updated
int 		Total number of non-terminated pods targeted by this deployment that have the desired template spec.

ServiceObservedWeight

(Appears on: AppStatus)

Field Description
lastWrite
Kubernetes meta/v1.Time
weight
int
serviceName
string

ServiceRevision

(Appears on: ServiceSpec)

ServiceRevision speficies the APP name, Version and Weight to uniquely identify each Revision

Field Description
version
string 		Revision Version
weight
int 		Revision Weight
app
string 		Revision App name

ServiceScale

(Appears on: ServiceSpec)

ServiceScale Specifies the scale parameters for Service

Field Description
scale
int 		Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
updateBatchSize
int 		(Optional) The maximum number of pods that can be scheduled above the desired number of pods. 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. 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 old pods have been killed, 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.

ServiceSource

(Appears on: Match)

Field Description
service
string
stack
string
revision
string

ServiceSpec

(Appears on: Service)

ServiceSpec represents spec for Service

Field Description
ServiceScale
ServiceScale
ServiceRevision
ServiceRevision
AutoscaleConfig
AutoscaleConfig
RolloutConfig
RolloutConfig
PodConfig
PodConfig
disableServiceMesh
bool 		Whether to disable ServiceMesh for Service. If true, no mesh sidecar will be deployed along with the 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
deploymentStatus
Kubernetes apps/v1.DeploymentStatus 		Most recently observed status of the Deployment.
firstRevision
string 		The first observed commit for the build
scaleStatus
ScaleStatus 		ScaleStatus for the Service
observedScale
int 		ObservedScale is calcaluted from autoscaling component to make sure pod has the desired load
weightOverride
int 		WeightOverride is the weight calculated from serviceset revision
containerImages
map[string]string
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 the service
publicDomains
[]string 		The list of publicdomains pointing to the service

StringMatch

(Appears on: 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

SystemServiceSpec

(Appears on: Service)

Field Description
updateOrder
string
updateStrategy
string
deploymentStrategy
string
global
bool
volumeClaimTemplates
[]Kubernetes core/v1.PersistentVolumeClaim
podSpec
Kubernetes core/v1.PodSpec

TemplateMeta

Field Description
name
string
version
string
iconUrl
string
readme
string
questions
[]Question

Volume

(Appears on: Container)

Field Description
Name
string
Path
string

WeightedDestination

(Appears on: RouteSpec)

Field Description
Destination
Destination
weight
int 		Weight for the Destination

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