Skip to content

CLOE API

Cloud Setup

Just use the public initions APIs

Local Setup

Setup

In the Database section within the Repository tab the GUI is able to crawl selected Snowflake Databases. To be able to use this feature it is necessary to setup a connection to the cloe api:

  1. Start Rancher Desktop
  • Make sure in the Rancher Desktop settings that under "Container Engine", "dockerd" is selected.
  • Also in the Rancher Desktop settings, consider deactivating "Kubernetes"
  1. Open command prompt and connect to cloe via entering:
  • docker login skrprdcloecontainersacr.azurecr.io
  • You will be asked to provide login information. Ask for username and password from Product Manager.
  1. Next, setup the docker container by running:
  • docker pull skrprdcloecontainersacr.azurecr.io/cloe-api:latest-prd
  • docker run -p 8080:80 -d --restart=always --name=cloe-api-secret skrprdcloecontainersacr.azurecr.io/cloe-api:latest-prd
  1. The setup is complete. To check the container status you can run this and check the status of your container, once it is not "starting" anymore you should be ready to go.
  • docker ps -a

To use the feature in the future, Rancher Desktop needs to be up and running.

In the CLOE GUI you now need to setup the URL to connect to the API. Go to Settings and enter http://localhost:8080 into the field "Model Secure API URL". You can now navigate to the Repository tab and once in the Database section click on "Update". The GUI will prompt for connection details, with which a connection to the provided Snowflake account and database will be established and the database, schema and table definitions are crawled and written into your database section. Under Database Filter you can define specific databases to be included in the crawl using RegEx. "Database Name Replace" can be used to define certain parts of the database name that should be parameterized.

Troubleshooting

If you are unable to connect to the API and you made sure that Rancher Desktop is up an running, open a command prompt and check the container health by entering

  • docker ps -a

If the container named "cloe-api-secret" is not running or displayed as healthy try restarting it using by entering

  • docker stop cloe-api-secret
  • docker rm cloe-api-scret
  • docker run -p 8080:80 -d --restart=always --name=cloe-api-secret skrprdcloecontainersacr.azurecr.io/cloe-api:latest-prd

Updating

When a new version of the container is released you need to update your container by running the following steps

  • docker stop cloe-api-secret
  • docker rm cloe-api-secret
  • docker pull skrprdcloecontainersacr.azurecr.io/cloe-api:latest-prd
  • docker run -p 8080:80 -d --restart=always --name=cloe-api-secret skrprdcloecontainersacr.azurecr.io/cloe-api:latest-prd