Getting Started

Installation

Installation Steps

1. Obtain Required Files:

   • Acquire the dsail_deployment.zip archive from your designated contact at Jaxon.
   • Obtain an IBM Docker registry API key from Jaxon as well.

2. Setup Environment:

   • Log in to your Ubuntu machine.
   • Create a directory named dsail in your home directory by executing:
     • mkdir -p $HOME/dsail
   • Transfer the dsail_deployment.zip file into the newly created $HOME/dsail directory.

3. Extract Deployment Files:

   • Navigate to the dsail directory:
     • cd $HOME/dsail
   • Extract the contents of the dsail_deployment.zip file:
     • unzip -o dsail_deployment.zip

4. LLM Configuration:

   • Edit the .llm_env file located in the $HOME/dsail directory.
     • Add any environment key variables required by your LLM provider. For example, replace <OPENAI_API_KEY> with a valid OpenAI API key.
   • Edit llm_config.yml to expose any LLMs you want available for use.
     • It is required that a default model named chat be configured; you may use any model you like to take this role.
     • model_name is exposed to users in the guardrail configuration UI. This is a human-readable label.
     • Specific models and configuration options are available here.
       • Jaxon Guardrails uses the LiteLLM proxy to decouple the guardrails from any single provider's LLM offerings.

5. Authenticate Docker:

   • Authenticate against the IBM Docker Container Registry using the previously obtained API key:
     • docker login -u iamapikey -p <apikey> icr.io
   • Replace <apikey> with your IBM Docker registry API key.

6. Start DSAIL with Docker:

   • Initiate the DSAIL stack by executing:
     • docker compose up -d
   • This action will pull the required DSAIL containers from the IBM container registry and Docker Hub.

7. Verify Stack Running:

   • Confirm that the DSAIL containers are up and running by executing the following command:
     • docker ps
   • This command lists the active containers within the DSAIL stack.

Install DSAIL as a System Service

To automate DSAIL's startup, configure it to run as a system service:

1. Stop the Existing Stack:

   • Navigate to the dsail directory and execute:
     • docker compose down

2. Service Configuration:

   • Edit the docker-compose-dsail.service file in the $HOME/dsail directory.
   • Replace /path/to/your/dsail/directory with the exact path, such as /home/my_user/dsail.

3. Deploy the Service File:

   • Copy the docker-compose-dsail.service file to the /etc/systemd/systemdirectory:
     • sudo cp docker-compose-dsail.service etc/systemd/system

4. Enable and Start the Service:

   • Activate the service by executing:
     • sudo systemctl enable docker-compose-dsail.service
   • Start the service:
     • sudo systemctl start docker-compose-dsail.service

5. Service Status Verification:

   • Verify the service's status using:
     • sudo systemctl status docker-compose-dsail.service

   • The output should denote successful execution, analogous to:

     Loaded: loaded (/etc/systemd/system/docker-compose-dsail.service; enabled; vendor preset: enabled) Active: active (exited) since Mon 2025-03-24 19:45:58 UTC; 1 day 20h ago Process: 326018 ExecStart=/usr/bin/docker compose up -d (code=exited, status=0/SUCCESS) Main PID: 326018 (code=exited, status=0/SUCCESS) CPU: 309ms

By following these steps, DSAIL will be successfully installed and operable on your Ubuntu system. For additional support, consult your system administrator or designated contact.

Next Steps

1. Review the Platform Overview
2. Work through the Tutorials
3. Implement Guardrails for your own application.