Skip to main content

Before you start

To get the most out of this guide, you will need to:

Features

The table below outlines the features available for this type of connection.
  • Native - This refers to when a database client connects through a specific protocol, such as an IDE or client libraries through hoop connect <connection-name>.
  • One Off - This term refers to accessing this connection from hoop web panel.
FeatureNativeOne OffDescription
TLS Termination ProxyThe local proxy terminates the connection with TLS, enabling the connection with the remote server to be TLS encrypted.
AuditThe gateway stores and audits the queries being issued by the client.
Data Masking (Google DLP)A policy can be enabled to mask sensitive fields dynamically when performing queries in the database.
Data Masking (MS Presidio)A policy can be enabled to mask sensitive fields dynamically when performing queries in the database.
Credentials OffloadThe user authenticates via SSO instead of using database credentials.
Interactive AccessInteractive access is available when using an IDE or connecting via a terminal to perform analysis exploration.

Configuration

NameTypeRequiredDescription
KUBECONFIGfilesystemyesA Kubeconfig File with permission to access the cluster
KUBERNETES_RESOURCEenv-varyesThe Kubernetes resource to target for executing commands (e.g., deployment/myapp, pod/mypod, statefulset/myapp)

​
Connection Setup

One-off commands can be executed inside a container using the kubectl exec command. The Web Console accepts inputs that are executed inside the container. 
  hoop admin create conn k8s -a <agent> \
	-e KUBECONFIG=file://$HOME/.kube/config \
	-e KUBERNETES_RESOURCE=deployment/myapp \
	-- kubectl exec --stdin $KUBERNETES_RESOURCE -- bash
The command above will allow users to execute commands inside the specified Kubernetes resource. This is useful for running scripts inside a container.

​
Command Line Usage Examples

  # execute 'env' inside the default container
  hoop exec k8s --input 'env'
  # execute 'ls -l' inside the default container
  hoop exec k8s -i 'ls -l'