User Agent

Overview

By installing QueryPie Agent, you can use SQL Clients like DataGrip and DBeaver, SSH Clients like iTerm and SecureCRT, and 3rd party applications like Lens and k9s.

Downloading and Running Agent App

1. After logging into QueryPie, click the profile in the top right and click the Agent Download button.

2. When the QueryPie Agent Downloads popup window opens, download the installation file that matches your PC’s operating system in Step 1, then copy the QueryPie URL in Step 3.

3. Run the downloaded QueryPie Agent installer to complete the installation.

4. Run the installed QueryPie Agent. Enter the previously copied QueryPie URL in the QueryPie Host input field and click the Next button to enter the login screen.

Logging into QueryPie Agent

1. Click the Login button on the login screen within the Agent app.

2. When the web browser opens, enter your authentication information on the login page and click the Continue button.

3. Upon successful login, the login success screen is displayed as shown below, and then you return to the Agent.

4. Explicitly perform Agent opening to transfer authentication information to the Agent.

Connecting to Database through Agent

1. After login is completed normally, you can check the connection information for authorized connections in the Databases tab within the Agent app.
   Click the Port assigned to the connection you want to connect to, and you can check the Proxy Credentials information for that connection.

2. Enter the above connection information into a 3rd party client to connect to the DB connection.

Server Access through Agent

After login is completed normally, you can check authorized servers in the Server tab within the Agent app.

1. Selecting Server Role

• Click the Role button below the user profile area to choose the desired role and click the OK button.
• When selecting the Default role, use the server permissions assigned through Workflow > Server Access Request.

2. Connecting to Server through Agent

• Right-click on the server you want to connect to and select the Open Connection with menu to choose the terminal tool you want to use.

• If there are multiple accounts that can access that server, an Account selection window opens.
• Select the account you want to use, enter the password if necessary, then click the OK button to open the session.

3. Setting Up Seamless SSH

Seamless SSH is a feature that allows you to connect to servers through QueryPie while maintaining existing terminal usability. You can easily set up seamless SSH by creating a config file in the .ssh folder using the following method.

1. Open a terminal and navigate to the .ssh folder.

$ cd .ssh

2. Open the vi editor to create a config file in the ssh folder.

$ vi config

3. Enter the following content, then type wq to exit the vi editor.

Host {{Server Name}}
  Hostname {{Server URL}}
  Port {{Server SSH Port}}
  ProxyCommand qpa ssh %r %h %p

Host *
  ProxyCommand qpa ssh %r %h %p

4. The setup is now complete. When you select a role in Agent > Server tab, you can connect to the server using the existing ssh command.

$ ssh deploy@{{Server Name}}

Kubernetes Access through Agent

• Authorized users automatically receive a kubeconfig file according to current policies when running the agent.
• Through this, you can access Kubernetes API resources using Kubernetes Client tools (kubectl, lens, k9s, etc.).
• The agent displays a list of accessible clusters and shows the policies applied to each cluster.
• You can also check and modify the location of the kubeconfig file through the settings menu.

1. Selecting Kubernetes Role

Click the Role button below the user profile area to open the role selection modal. Choose the desired role and click the OK button.

2. Viewing Policy

Resources accessible according to the selected role are displayed. Click the 🔍 button on the right of each cluster to display the Policy Information popup window where you can check the detailed list of policies applied to that cluster.

3. Setting Kubeconfig Path

Click the KubeConfig Path button in the Agent settings menu to open the Kubeconfig path configuration modal.

• Path Configuration: You can specify the storage path for the Kubeconfig file.
  • The default value is ${HOME}/.kube/querypie-kubeconfig.
  • Click the Upload button on the right of the path field to display a popup where you can specify a local file path.

• Where: Click the 🔽 button on the right to specify the desired folder.
• Save As: Enter the name of the Kubeconfig file. If not changed, the default value is applied.
• Command Line: Provides a command line for declaring the KUBECONFIG environment variable.

1. When setting the KUBECONFIG environment variable for the first time, you must change the default "${KUBECONFIG}" value in the command line to "${HOME}/.kube/config" before use.

export KUBECONFIG="${HOME}/.kube/config:${HOME}/.kube/querypie-kubeconfig"

2. When changing the user-specified kubeconfig path provided by QueryPie, you must redeclare the environment variable with the new path.

export KUBECONFIG="${KUBECONFIG}:<user-specified path>"

3. For more detailed information about kubeconfig, please refer to the following links:

• Reference: kubeconfig file merging 
• Reference: KUBECONFIG environment variable setting 

4. Copy the command line and declare it in the client to switch the context to an accessible cluster

export KUBECONFIG="${KUBECONFIG}:${HOME}/.kube/querypie-kubeconfig"

Resetting QueryPie Agent Settings

Resetting settings will initialize the QueryPie Host information you entered, allowing you to enter it again.

Reset from Agent Settings Menu

Click the ⚙️ button on the right of the profile area to open the settings menu. Click the Reset All Settings button.

(Mac) Reset from App Menu in Menu Bar

Click the QueryPie Agent icon in the menu bar to open the app menu. Click the Reset All Settings button.