Configuration

🚧

Quick command summary

orka config
orka config -a <ORKA_API_URL> -l <ORKA_LICENSE_KEY> --output-style <OUTPUT-STYLE> -y

Command

This command lets you set the API URL, the license key, and the output style.

orka config

OR

orka config -a <ORKA_API_URL> -l <ORKA_LICENSE_KEY> --output-style <OUTPUT-STYLE> -y

Output

• (Required) For URL, provide the service endpoint for your Orka environment in the following format: http://<orka-service-endpoint-ip> or https://<external-custom-domain>.

📘

What's your Orka endpoint?

You can get the IP for your Orka endpoint from your IP Plan:

• For clusters deployed before Orka 2.1, it's the .100 address for your Private-1 network (usually, 10.221.188.100).
• For clusters deployed with Orka 2.1 or later, it's the .20 address for your Private-1 network (usually 10.221.188.20).
  You need to use http with the IP.

📘

Known limitation

Due to Node.js limitations, the Orka CLI cannot work with the built-in Orka domains and can work only with a limited number of external custom domains.

The Orka CLI works only with valid TLS certificates issued by the certificate authorities recognized by Node.js.

• (Optional) For License key, provide your Orka license key as provided in your IP Plan or by an administrator.
• (Optional) For Output style, set TABLE or JSON. If you set JSON, the Orka CLI will always print the JSON output of your commands. When the default output is JSON, you cannot run commands in interactive mode.

Options

You can pass the following options in direct mode: