Laptop-side configuration

Global Configuration

Telepresence uses a config.yml file to store and change certain global configuration values that will be used for all clusters you use Telepresence with. The location of this file varies based on your OS:

  • macOS: $HOME/Library/Application Support/telepresence/config.yml
  • Linux: $XDG_CONFIG_HOME/telepresence/config.yml or, if that variable is not set, $HOME/.config/telepresence/config.yml
  • Windows: %APPDATA%\telepresence\config.yml

For Linux, the above paths are for a user-level configuration. For system-level configuration, use the file at $XDG_CONFIG_DIRS/telepresence/config.yml or, if that variable is empty, /etc/xdg/telepresence/config.yml. If a file exists at both the user-level and system-level paths, the user-level path file will take precedence.

Values

The config file currently supports values for the timeouts, logLevels, images, cloud, and grpc keys.

Here is an example configuration to show you the conventions of how Telepresence is configured: note: This config shouldn't be used verbatim, since the registry privateRepo used doesn't exist

yaml
timeouts:
agentInstall: 1m
intercept: 10s
logLevels:
userDaemon: debug
images:
registry: privateRepo # This overrides the default docker.io/datawire repo
agentImage: ambassador-telepresence-agent:1.8.0 # This overrides the agent image to inject when intercepting
cloud:
refreshMessages: 24h # Refresh messages from cloud every 24 hours instead of the default, which is 1 week.
grpc:
maxReceiveSize: 10Mi

Timeouts

Values for timeouts are all durations either as a number respresenting seconds or a string with a unit suffix of ms, s, m, or h. Strings can be fractional (1.5h) or combined (2h45m).

These are the valid fields for the timeouts key:

FieldDescriptionDefault
agentInstallWaiting for Traffic Agent to be installed2 minutes
applyWaiting for a Kubernetes manifest to be applied1 minute
clusterConnectWaiting for cluster to be connected20 seconds
interceptWaiting for an intercept to become active5 seconds
proxyDialWaiting for an outbound connection to be established5 seconds
trafficManagerConnectWaiting for the Traffic Manager API to connect for port fowards20 seconds
trafficManagerAPIWaiting for connection to the gPRC API after trafficManagerConnect is successful15 seconds

Log Levels

Values for logLevels are one of the following strings: trace, debug, info, warning, error, fatal and panic. These are the valid fields for the logLevels key:

FieldDescriptionDefault
userDaemonLogging level to be used by the User Daemon (logs to connector.log)debug
rootDaemonLogging level to be used for the Root Daemon (logs to daemon.log)info

Images

Values for images are strings. These values affect the objects that are deployed in the cluster, so it's important to ensure users have the same configuration.

Additionally, you can deploy the server-side components with Helm, to prevent them from being overridden by a client's config and use the mutating-webhook to handle installation of the traffic-agents.

These are the valid fields for the images key:

FieldDescriptionDefault
registryDocker registry to be used for installing the Traffic Manager and default Traffic Agent. If not using a helm chart to deploy server-side objects, changing this value will create a new traffic-manager deployment when using Telepresence commands. Additionally, changing this value will update installed default traffic-agents to use the new registry when creating a new intercept.docker.io/datawire
agentImage$registry/$imageName:$imageTag to use when installing the Traffic Agent. Changing this value will update pre-existing traffic-agents to use this new image. the registry value is not used for the traffic-agent if you have this value set
webhookRegistryThe container $registry that the Traffic Manager will use with the webhookAgentImage This value is only used if a new traffic-manager is deployed
webhookAgentImageThe container image that the Traffic Manager will use when installing the Traffic Agent in annotated pods This value is only used if a new traffic-manager is deployed

Cloud

Values for cloud are listed below and their type varies, so please see the chart for the expected type for each config value. These fields control how the client interacts with the Cloud service.

FieldDescriptionTypeDefault
skipLoginWhether the cli should skip automatic login to Ambassador Cloud. If set to true, you must have a license installed in the cluster in order to be able to perform selective interceptsbools: 1, t, T, TRUE, true, True, 0, f, F, FALSEfalse
refreshMessagesHow frequently the CLI should communicate with Ambassador Cloud to get new command messages, which also resets whether the message has been raised or not. You will see each message at most once within the duration given by this configduration: number respresenting seconds or a string with a unit suffix of ms, s, m, or h168h

Telepresence attempts to auto-detect if the cluster is air-gapped, be sure to set the skipLogin value to true

Reminder: To use selective intercepts, which normally require a login, you must have a license in your cluster and specify which agentImage should be installed, by also adding the following to your config.yml:

shell
images:
agentImage: <privateRegistry>/<agentImage>

Grpc

The maxReceiveSize determines how large a message that the workstation receives via gRPC can be. The default is 4Mi (determined by gRPC). All traffic to and from the cluster is tunneled via gRPC.

The size is measured in bytes. You can express it as a plain integer or as a fixed-point number using E, G, M, or K. You can also use the power-of-two equivalents: Gi, Mi, Ki. For example, the following represent roughly the same value:

shell
128974848, 129e6, 129M, 123Mi

Per-Cluster Configuration

Some configuration is not global to Telepresence and is actually specific to a cluster. Thus, we store that config information in your kubeconfig file, so that it is easier to maintain per-cluster configuration.

Values

The current per-cluster configuration supports dns, alsoProxy, and manager keys. To add configuration, simply add a telepresence.io entry to the cluster in your kubeconfig like so:

shell
apiVersion: v1
clusters:
- cluster:
server: https://127.0.0.1
extensions:
- name: telepresence.io
extension:
dns:
also-proxy:
manager:
name: example-cluster

DNS

The fields for dns are: local-ip, remote-ip, exclude-suffixes, include-suffixes, and lookup-timeout.

FieldDescriptionTypeDefault
local-ipThe address of the local DNS server. This entry is only used on Linux system that are not configured to use systemd.resolvedipfirst line of /etc/resolv.conf
remote-ipthe address of the cluster's DNS serviceipIP of the kube-dns.kube-system or the dns-default.openshift-dns service
exclude-suffixessuffixes for which the DNS resolver will always fail (or fallback in case of the overriding resolver)list
include-suffixessuffixes for which the DNS resolver will always attempt to do a lookup. Includes have higher priority than excludes.list
lookup-timeoutmaximum time to wait for a cluster side host lookupduration

Here is an example kubeconfig:

shell
apiVersion: v1
clusters:
- cluster:
server: https://127.0.0.1
extensions:
- name: telepresence.io
extension:
dns:
include-suffixes:
- .se
exclude-suffixes:
- .com
name: example-cluster

AlsoProxy

When using also-proxy, you provide a list of subnets after the key in your kubeconfig file to be added to the TUN device. All connections to addresses that the subnet spans will be dispatched to the cluster

Here is an example kubeconfig for the subnet 1.2.3.4/32:

shell
apiVersion: v1
clusters:
- cluster:
server: https://127.0.0.1
extensions:
- name: telepresence.io
extension:
also-proxy:
- 1.2.3.4/32
name: example-cluster

Manager

The manager key contains configuration for finding the traffic-manager that telepresence will connect to. It supports one key, namespace, indicating the namespace where the traffic manager is to be found

Here is an example kubeconfig that will instruct telepresence to connect to a manager in namespace staging:

yaml
apiVersion: v1
clusters:
- cluster:
server: https://127.0.0.1
extensions:
- name: telepresence.io
extension:
manager:
namespace: staging
name: example-cluster