Solution CLI Setup

Before you can use the Solution CLI tool you need to install it and run the set up:

  1. Go to Solution Designer and open your modeled solution.
  2. At the bottom you will find a menu bar. Click on Solution CLI to expand the pane.
  3. Inside this pane click on Solution CLI Setup to expand the section. You will find instructions on how to install and set up the CLI.
  4. Click on the provided link to download the CLI.tar file.
  5. After successfully downloading the file open a terminal on your machine and paste in the following code to install the CLI on your computer (replace <download folder> with the folder you have downloaded the CLI.tar to):
    npm install -g <download folder>/CLI.tar
  6. Switch back to the Solution CLI Setup section in Solution Designer and download cli-config.json by clicking on the provided link.
  7. Run the following command in your terminal to set up the cli (replace <download folder> with the folder you have downloaded the cli-config.json to):
    fss setup --file <download folder>/cli-config.json

To be able to run tests on deployments inside this project from within your IDE you also need to set up the cli to work with the corresponding Solution Envoy.

  1. Go to Solution Designer and open your modeled solution.
  2. In the navigation bar on the left click on "CI/CC"
  3. On the "Pipeline Configurations" tab click on the link to the project you want to work on. This will open a new tab and lead you to the OpenShift Web Console.
  4. In the navigation bar of the OpenShift Web Console choose the "Developer"-view to see the "Topology"-button.
  5. After clicking on the "Topology"-button you will be presented with all solutions deployed in this project. By clicking on the icon with the little arrow of one of the solutions you will be redirected to the Solution Envoy of this project.
  6. Login to Solution Envoy with valid credentials.
  7. Click on "Infrastructure" section and use the "Download"-button on the "Solution CLI Setup" card to download the configuration file.
  8. Run the following command in your terminal to set up the cli (replace <download folder> with the folder you have downloaded the file to and replace filename with the actual name of the downloaded file):
    fss setup-envoy --file <download folder>/<filename>
Note: Remember that you have to repeat the setup steps (excl. installation) every time you work on a different project.