The email of the application owner.
email: "[email protected]"
endpoint: The public endpoint of your Kubernetes cluster. It will be used by Okteto when generating
Kubeconfigcredentials for your users.
Okteto Enterprise is free to try. Without a license, you'll be limited to managing up to 3 users with 3 namespaces each.
Don't have a license? Talk to us and start your free trial today.
You can also use a secret to store the license.
The domain (or subdomain) managed by Okteto Enterprise.
Your Okteto Enterprise instance will be available at
okteto.$SUBDOMAIN. All ingresses created by okteto will be use it as well (e.g. https://app-$NAMESPACE.$SUBDOMAIN)
After installation, we recommend that you create a DNS entry for
*.$SUBDOMAIN, pointing to the public address of your load balancer.
Okteto Enterprise supports using Bitbucket, Github, Google or OpenID Connect as authentication providers.
You can also use a secret to store the sensitive part of these credentials.
bitbucket: Use this group of settings when using Bitbucket OAauth as your authentication provider.
auth:bitbucket:enabled: trueclientId: OAauth Consumer KeyclientSecret: OAauth Consumer Secretworkspace: my-workspace
workspace field is optional. Only members of the workspace will be allowed to login into your Okteto Enterprise instance. An empty
workspace field permits any user to login.
github: Use this group of settings when using Github OAauth as your authentication provider.
auth:github:enabled: trueclientId: clientIDclientSecret: clientSecretorganization: my-org
organization field is optional. Only members of the organization will be allowed to login into your Okteto Enterprise instance. An empty
organization field permits any user to login.
auth:google:enabled: trueclientId: clientid.apps.googleusercontent.comclientSecret: clientSecret
openid: Use this group of settings when using an OpenID Connect provider as your authentication provider.
auth:openid:enabled: trueclientId: clientidclientSecret: clientSecretgroup: my-groupendpoints:issuer: https://your-providerauthorization: https://your-provider/authorizationmapping:externalIDKey: nicknamenameKey: nameemailKey: emailpictureKey: picturegroupsKey: groups
group field is optional. Only members of the group will be allowed to login into your Okteto Enterprise instance. An empty
group field permits any user to login.
authorization endpoints must match the value returned in the provider config discovery.
mapping fields are optional. Use them to configure the mapping between Okteto's user attributes and the claim coming from your authentication provider.
Your provider needs to support the UserInfo endpoint in order to be used with Okteto Enterprise.This authentication option follows the OpenID standard, and it has been validated with Okta, PingIdentity and Gitlab.
Okteto Enterprise integrates with different cloud providers to store the registry images and generate certificates for your applications.
The credentials will be used by cert-manager when generating and renewing the wildcard certificate. The sensitive part of the credentials are not included in the configuration file. Instead, it is provided to Okteto Enterprise via a secret.
azure: Use this if your domain is managed by Azure DNS, and to use Azure Storage to store your private images.
cloud:provider:azure:enabled: trueservicePrincipal: "Service Principal ID"subscriptionID: "Azure Subscription ID"tenantID: "Azure Tenant ID"resourceGroupName: "Resource Group Name"storage:container: "Storage Container Name"accountName: "Storage Account Name"
The storage setting will be used by the registry to pull and push images (if using cloud storage). This needs to be created before installing Okteto Enterprise.
aws: Use this if your domain is managed by Route53, and to use S3 to store your private images.
cloud:provider:aws:enabled: truebucket: "Bucket Name"region: "AWS region"iam:accessKeyID: "IAM Access Key"
The bucket will be used by the registry to pull and push images (if using cloud storage). This needs to be created before installing Okteto Enterprise.
role configuration below if your Route53 zone is managed by a separate AWS account that the one used to provision your Kubernetes cluster.
cloud:provider:aws:enabled: truebucket: "Bucket Name"region: "AWS region"iam:enabled: falserole:enabled: truearn: "Role arn"hostedZoneID: "zone id"
digitalocean: Use this if your domain is managed by DigitalOcean, and to use Digital Ocean spaces to store your private images.
The space settings will be used by the registry to pull and push images (if using cloud storage). This needs to be created before installing Okteto Enterprise.
gcp: Use this if your domain is managed by Google Cloud DNS, and to use Google Cloud Storage to store your private images.
cloud:provider:gcp:enabled: truebucket: "Bucket Name"project: "Project ID"
The bucket settings will be used by the registry to pull and push images (if using cloud storage). This needs to be created before installing Okteto Enterprise.
byo: Use this if you're using a provider not currently supported by Okteto Enterprise.
cloud:provider:byo:enabled: trueissuerName:issuerKind: Issuer
byo you'll need to create a valid cert-manager issuer before installing Okteto Enterprise, and configure your registry to use the file system for storage.
Advanced Cloud Scenarios
It is possible to use separate cloud providers for DNS than for storage if needed. Reach out to us, we are always happy to help!
Okteto Enterprise Components
The API service. Account and Kubernetes credentials management, namespace creation and sharing, deployment via the catalog, etc...
annotations: Annotations to add to the API pods.
labels: Labels to add to the API pods.
replicaCount: The number of API pods. It defaults to 2.
resources: The resources for the API pods.
api:replicaCount: 2resources:requests:cpu: 100mmemory: 128Mi
The cluster autoscaler service.
It instructs the Kubernetes cluster autoscaler to scale nodes if the cumulative resource requests of pods running in a node or the real cpu/memory usage of a node is beyond the limits.
tolerations.devPool to limit the autoscaler analysis to a subset of cluster nodes.
autoscaler:enabled: falseschedule: 300up: 80down: 60increment: 1min: 1max: 10slackWebhook:
annotations: Annotations to add to the autoscaler pods.
down: Decrease the cluster size when the CPU or memory consumption is lesser than this value. It defaults to 60 percent.
increment: the number of new nodes to request when all the current nodes are overloaded. e.g. if this value is 3, the autoscaler will request three new nodes when all the cluster nodes are overloaded. It defaults to 1.
labels: Labels to add to the autoscaler pods.
max: maximum number of nodes in the cluster. It defaults to 10. Zero means unlimited.
min: minimum number of nodes in the cluster. It defaults to 1.
schedule: how often, in seconds, the autoscaler analyzes if the cluster needs to be scaled. It defaults to 300.
slackWebhook: a slack webhook url to notify autoscaler events.
up: Increase the cluster size when the CPU or memory consumption is greater than or equal to this value. It defaults to 80 percent.
Requirements: cluster autoscaler and metrics server must be installed in your cluster.
The build service. It's used in combination with
okteto build to build containers directly in the cluster.
annotations: Annotations to add to the buildkit pods.
labels: Labels to add to the buildkit pods.
replicaCount: The number of buildkit pods. It defaults to 1.
resources: The resources for the buildkit pods.
storage.size: The size of the volume attached to every pod. It's used to store image caches.
storage.cache: The size of the buildkit cache to store image caches. It should be 30Gi smaller than
buildkit:replicaCount: 1storage:size: 180Gicache: 150000
The daemonset automatically configures every node of your cluster to work better with Okteto.
annotations: Annotations to add to the daemonset pods.
labels: Labels to add to the daemonset pods.
The frontend service serves the web application.
annotations: Annotations to add to the frontend pods.
labels: Labels to add to the frontend pods.
replicaCount: The number of frontend pods. It defaults to 2.
resources: The resources for the frontend pods.
frontend:replicaCount: 2resources:requests:cpu: 100mmemory: 128Mi
The garbage collector service. It automatically scales idle applications to zero and deletes unused namespaces.
annotations: Annotations to add to the gc pods.
labels: Labels to add to the gc pods.
scaleToZeroPeriod: The duration, in hours, that an application or resource must be idle before the garbage collector scales it to zero. Set to zero to disable.
deleteNamespacePeriod: The duration, in days, that a namespace must be idle before the garbage collector deletes it. Set to zero to disable.
slackWebhook: If set, the garbage collector will send a notification when it scales a resource to zero or when it deletes a namespace.
gc:enabled: falsescaleToZeroPeriod: 24deleteNamespacePeriod: 15slackWebhook:
The private container registry.
annotations: Annotations to add to the registry pods.
labels: Labels to add to the registry pods.
pullPolicy: The security policy for image pulls. If set to
cluster, any Okteto Enterprise user can pull any image from the registry. When set to
namespace, only users with access to the namespace can pull images from the namespace. It defaults to
replicaCount: The number of registry pods. It defaults to 1.
resources: The resources for the registry pods.
serviceAccountName: The service account used by the registry. It defaults to
storage: The storage mechanism for the images.
cloud.enabled: Set this to true if you want to store the images using your cloud provider's block storage service (e.g. S3). It will use the values defined in the
cloudkey. It's enabled by default.
filesystem: Set this to true if you want to store the images in PVC attached to the registry. This might limit your ability to scale up the registry, depending on the type of storage you are using. You can also customize the
sizeof the volume, and even attach an existing volume claim via
registry:storage:cloud:enabled: falsefilesystem:enabled: truepersistence:claimName: ""accessMode: ReadWriteOncestorageClass: ""size: 40Gi
You can enable or disable the telemetry job. The telemetry job "phones home" once a day with the following information:
- Number of managed users
- Number of managed namespaces
- Kubernetes Version and Platform
- A unique install ID
- Your license ID.
Okteto uses the information to help us better understand how our customers use Okteto Enterprise, as well as to help us prioritize fixes and features. We don't share your information with anyone else.
The webhook service. Ingress creation, generation of hostnames, enforcement of policies, etc...
annotations: Annotations to add to the webhook pods.
labels: Labels to add to the webhook pods.
replicaCount: The number of webhook pods. It defaults to 2.
resources: The resources for the webhook pods.
repository: The default application repository for every Okteto Enterprise user. It defaults to
https://apps.okteto.comwhen not specified.
The role Okteto assigns to every user. If empty, Okteto will create a default role.
clusterRole: "role name"
Converts services with type LoadBalancer into ClusterIP and automatically creates an ingress. Enabled by default.
Configure default values for the ingress created by Okteto Enterprise.
ingress:annotations:kubernetes.io/ingress.class: nginxclass: nginxforceIngressClass: falseip: ""
annotations: The annotations to apply to all the ingresses created during the Okteto Enterprise installation.
class: If set, Okteto Enterprise will set this as the
ingress.classof all ingresses managed by Okteto. This is useful if you have more than one ingress controller in your cluster.
forceIngressClass: If enabled, all ingresses deployed in namespaces managed by Okteto will have the ingress class defined in
ip: The internal IP of the ingress. This will be used by the pods to call the Okteto API and access the Okteto Registry. Required if the Okteto API/Registry is exposed using an ingress not managed by Okteto.
Configure ingress connections limits for each public endpoint.
Disabled by default.
ingressLimits:enabled: trueconnections: 40rps: 40rpm: 400
connections: maximum parallel connections for each ingress.
rps: maximum requests per second for each ingress.
rpm: maximum requests per minute for each ingress.
Automatically inject kubectl, helm, and okteto binaries on every development environment, and on the git and helm deployment pipelines. This requires permissions to mount a host volume.
If this is disabled, you'll need to provide your own images in
Configures network policies for each namespace to isolate network traffic. Disabled by default.
networkPolicies:enabled: truecidr: "10.166.0.0/20"
cidr: CIDR of the worker nodes in your cluster. Required if network policies are enabled.
Overrides the default kernel values for file watchers in every node. Recommended if you're running databases, or if you plan on using "okteto up" on the cluster. This requires permission to mount and modify /proc values.
overrideFileWatchers:enabled: truemaxUserWatches: 10048576maxMapCount: 262144aioMaxNR: 1000000
maxUserWatches: The maximum number of allowed inotify watchers.
maxMapCount: The maximum number of memory map areas a process may have.
aioMaxNR: The maximum number of allowable concurrent IO requests.
Overrides the registry hostname resolution to use internal IPs. This requires permission to mount and modify the cluster nodes' /etc/hosts file.
Pre-pull the git and helm installer images in all the nodes. This requires permission to mount the docker socket.
A list of private registries and its corresponding credentials. The kubelet will use them when pulling images:
privateRegistry:hub:url: https://index.docker.io/v1/user: username1password: password1gcr:url: https://gcr.iotoken: dXNlcjM6cGFzc3dvcmQzCg==
token if your registry does not support username/password authentication (e.g. google registry).
PullAlways image pull policy in the cluster. Enabled by default.
The list of shortcuts to show in the "Deploy from Git Repository" dialog.
quickstarts:- name: "Movies Sample App"url: https://github.com/okteto/movies- name: "Github"url: https://github.com/- name: "Gitlab"url: https://gitlab.com/- name: "Bitbucket"url: https://bitbucket.org/
Enables resource quotas at the namespace level. Disabled by default.
quotas:resources:enabled: truemaxNamespaces: "3"maxPods: "20"maxServices: "20"maxReplicationControllers: "30"maxSecrets: "20"maxConfigMaps: "20"maxPVCs: "10"bandwidth:enabled: trueingress: "800M"egress: "800M"requests:enabled: truecpu: "1"memory: "2Gi"storage: "20Gi"limits:enabled: truecpu: "4"memory: "8Gi"storage: "20Gi"limitranges:max:enabled: truecpu: "2"memory: "4Gi"requests:enabled: truecpu: "100m"memory: "0.2Gi"limits:enabled: truecpu: "500m"memory: "1Gi"
Labels and annotations to include in the secret created by the chart. Useful if you want to integrate with Vault or similar secret stores.
secret:annotations:your.custom.annotation: "10"labels:your.custom.label: "20"
Indicates tolerations for the okteto components.
Define the label and taint
okteto-node-pool on your worker nodes to match these values.
tolerations:oktetoPool: oktetobuildPool: builddevPool: dev
oktetoPool: tolerations for the api, webhook, gc, autoscaler, ingress controller and frontend services.
buildPool: tolerations for the buildkit and registry services.
devPool: tolerations for the pods deployed in namespaces created by okteto.
For example, if you add the label
okteto-node-pool:build and the taint
okteto-node-pool=build:NoSchedule to a node, and you
buildPool: build, the buildkit and registry pods will be deployed to this node.
Disable if you want to enforce using the
username as a suffix on namespaces and ingress hosts. Enabled by default.
Enables users to initialize persistent volume claims with the contents of a preexisting volume snapshot.
This feature requires having a CSI driver installed in your cluster.
volumeSnapshots:enabled: truedriver: ebs.csi.aws.comclass: snapclassstorageClass: ebs-sc
driver: the name of the CSI driver used when creating snapshots.
class: the VolumeSnapshotClass of the volume snapshot.
storageClass: (optional) the storage class required by volumes initialized from snapshots.
dev.okteto.com/from-snapshot-id annotation to any persistent volume claim to tell Okteto to initialize your persistent volume claim, as shown below:
apiVersion: v1kind: PersistentVolumeClaimmetadata:annotations:dev.okteto.com/from-snapshot-id: snap-xxxxxxxxname: pvc-namespec:accessModes:- ReadWriteOnceresources:requests:storage: 10Gi
When a persistent volume claim resource is created, Okteto will import the snapshot in Kubernetes using a VolumeSnapshotContent and will set the source of your persistent volume claim to this VolumeSnapshotContent.
nginx-ingress keys in your configuration file to modify the configuration.
For example, to change the number of replicas, you'd need to add the following:
The full list of values is available here.
cert-manager keys in your configuration file to modify the configuration.
For example, to change the number of replicas, you'd need to add the following:
The full list of values is available here.