Sign in
agent:

Saas DagKnows proxy setup instructions

There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

This runbook shows how to create a DagKnows proxy in the Saas and interact with it.

  1. 1

    Repository Checkout

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Clone the DK Proxy repository from GitHub to the local system using the following command. This step is crucial to obtain the latest version of DK Proxy and its associated files.

    git clone https://github.com/dagknows/dkproxy.git
    copied
    1
  2. 2

    Preparing the Instance

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Prepare the instance for DK Proxy. This involves navigating to the appropriate directory, updating the package lists, installing the 'make' tool, and running the preparation script.

    For Ubuntu Instance use the following commands:-

    cd dkproxy sudo apt-get update sudo apt-get install -y make make prepare
    copied
    2
  3. 3

    Installing DagKnows CLI

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Install the DagKnows Command Line Interface (CLI). This tool provides wrappers for interacting with DagKnows and managing proxies. The force reinstall option ensures the latest version is installed.

    pip install dagknows --force-reinstall
    copied
    3
  4. 4

    Add the path

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Add the executable path to the environment variable

    export PATH=$PATH:/home/ubuntu/.local/bin
    copied
    4
  5. 5

    Create an access token

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
    1. Log into DagKnows UI
    2. Go to Settings
    3. Look for "Generate access token"
    4. Enter a label in the label box. No special characters.
    5. Specify a period (e.g. 1 year)
    6. Click Generate
    7. Verify the token shows up in the table below.
    8. Copy the token by clicking copy button
    5
  6. 6

    Configuring DagKnows CLI

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Configure the DagKnows CLI by providing an access token. This step involves specifying the host address for the SaaS instance where DagKnows is running (this can vary for onprem or custom installations) and entering the access token obtained from the app's settings page.

    dk config init
    copied
    6
  7. 7

    Creating a Proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Create a new proxy or use an existing one. First, list available proxies, then create a new one with a unique label or select an existing proxy.

    dk proxy list dk proxy new <LABEL>
    copied
    7
  8. 8

    Provision the proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    The following command actually creates a proxy in the k8s.

    Keep proxynamespace same as LABEL, the one that you assigned to the proxy.

    dk proxy provision <org> <proxynamespace> <LABEL>
    copied
    8
  9. 9

    Obtaining Environment File for Proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.

    Retrieve and install a basic .env file for the proxy. This file contains necessary configurations for the proxy to connect to the SaaS instance.


    dk proxy getenv <LABEL>
    copied
    9
  10. 10

    Access the proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
    10
    1. 10.1

      Go to the right folder and unzip the files

      There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
      cd ./k8s/proxies tar xvzf <LABEL>.tar.gz cd ./theproxy
      copied
      10.1
    2. 10.2

      List roles etc

      There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
      sh vlt.sh roles list
      copied
      10.2
  11. 11

    Create roles to access credentials in proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
    1. Log into DagKnows
    2. Go to Settings
    3. Click on the Proxies tab on the top
    4. Look for the table "Proxy Roles"
    5. Add a role label. e.g. admin, superuser etc. No special characters.
    6. Click Add
    11
  12. 12

    Assign the proxy role to a user

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
    1. Log into DagKnows
    2. Click on "User Management" in left navbar
    3. Click on the user ID you want to assign roles to
    4. Click on "Modify settings"
    5. On the right side the user details, look for Proxy Roles and select a role to assign on a proxy
    6. Click modify
    7. Ensure that the user now has the role assigned
    12
  13. 13

    Execute a simple task on the proxy

    There was a problem that the LLM was not able to address. Please rephrase your prompt and try again.
    1. Create a runbook with some simple command
    2. Try executing it, the command will execute on the proxy
    13