Skip to main content
Feedback

Install OPTIONS

The page includes a list of command options that help you identify the Required parameters, Optional parameters, and Flags when installing the quickstart application.

For example, if you want to check if the MOM API key is needed in tethered or untethered mode, then run the following command:

./quickstart.sh -h

Required Parameters

  • -d

    The password for your DDL account with sufficient permission to create tables.

  • -b

    The password for your DML account with sufficient permission to perform CRUD queries.

  • -p

    This is the Cloud API Management - Local Edition administrator password for your account with administrator access to ConfigUI.

  • -S

    This is the quickstart trust store password.

  • -k

    This is the Mashery Onprem Manager (MOM) API key. It is required in tethered mode but optional in untethered mode.

  • -r

    This is the Mashery Onprem Manager (MOM) API secret. It is required in tethered mode but optional in untethered mode.

  • -U

    This is your Area UUID in Cloud API Management. You can sign in to Cloud API Management to find it. It is required in tethered mode.

  • -A

    This is your Area ID in Cloud API Management. You can sign in to Cloud API Management to find it. It is required in tethered mode but optional in untethered mode.

Optional Parameters

  • -u

    The DDL user for your account who has sufficient permission to create the Cloud API Management - Local Edition schema. The default value is root.

  • -s

    The Cloud API Management - Local Edition database name. The default value is masherysolar.

  • -t

    The DML user for your account who has sufficient permission to run DML queries on the database. The default value is masheryonprem.

  • -a

    The default value for the Cloud API Management - Local Edition administrator. The default value is administrator.

  • -m

    The minikube user profile name. The default value is minikube. This option can be used in combination with the flag -i.

  • -o

    The Cloud API Management - Local Edition local domain. You can change the domain name to any other name. The default value is quickstart.com.

  • -e

    The Cloud API Management - Local Edition deployment mode.

    • Default value: tethered
    • Allowed values: tethered, untethered

  • -N

    The Kubernetes namespace. By default, resources are created in the camleqs namespace.

  • -D

    The database host name or IP address. By default, this is set to the active IP address of the machine on which you are installing quick start.

  • -P

    The database port. The default value is 3306.

Flags

  • -i

    This creates a minikube profile if one does not already exist. It is used along with -m. By default, it is set to OFF.

  • -n

    Dry run. The dry run runs only the checkers and does not start or create any artifacts. By default, it is set to OFF.

  • -g

    This is used to control image generation. By default, it is enabled.

  • -v

    This controls the verbosity of logs. It can be used multiple times. The default value is —vv.

    • -v - ERROR level
    • -vv - WARN level
    • -vvv - INFO level
    • -vvvv - DEBUG level

  • -h

    This shows the help information.

On this Page