Tips and tricks for using APICUP
The APICUP installer in Install Assist contains built-in time saving functions.
This section describes tips and techniques for working with the APICUP installation commands. The APICUP installer creates charts and secrets that are then managed by Helm.
Running Tiller with APICUP
Entering multiple settings per command
To configure multiple settings per command, enter a space between each setting and enter an equals sign (=) to configure the setting.
In the following examples, be sure to replace [spc] with an actual space.
apicup subsys set mgmt cassandra-max-memory-gb=9[spc]cassandra-cluster-size=3[spc]cassandra-volume-size-gb=16[spc]cassandra-backup-protocol=sftp
apicup subsys set mgmt platform-api=my.platform.com[spc]api-manager-ui=my.apim.com[spc]cloud-admin-ui=my.cloud.com[spc]consumer-api=my.consumer.com
Entering multiple values
apicup subsys set mgmt dns-servers=220.127.116.11,18.104.22.168 search-domains=a.com,b.com
Viewing the settings for a subsystem
To view the current values that are set for a subsystem, enter the following command:
apicup subsys get <subsys_name>. For example:
apicup subsys get
mgmt outputs the current values for the subsystem named
mgmt and provides
a description of each value. is organized into Kubernetes settings and Subsystem settings.
Following is an example of the output from the
Validating the settings for a subsystem
The values set for a subsystem can be validated for syntax by entering the
--validate option for the
apicup subsys get
<subsys_name> --validate. For example:
apicup subsys get mgmt
--validate validates the current values for the subsystem named
the following example of the output for the
--validate option, the check mark
indicates a valid setting. The x indicates an invalid setting with an error message provided.
Output an installation plan
Using APICUP, you can generate an installation plan and confirm it is correct prior to running the installation. You can then install the subsystem from the plan.
To output an installation plan, enter the following command:
apicup subsys install SUBSYS --out=install-plan
where <install-plan> is the name of the directory where the installation plan will be stored.
In the example, a directory named install-plan is created in the project directory. The myProject/install-plan directory contains the configuration parameters for the subsystem.
To install the subsystem from the install-plan, enter the following command from the project directory:
apicup subsys install SUBSYS --plan-dir=<full-path-to-plan-directory>
where <full-path-to-plan-directory> is the full qualified path to the plan directory.
Following are general rules for installing from the installation plan:
- Never edit the files in the output directory directly. Instead, if changes are needed, update the parameters using APICUP and generate a new plan.
- Always run APICUP commands from the original project directory created during the initial product installation. The project directory contains the apiconnect-up.yml file.
- You can generate the plan in any location, but the install command must be run from the project
directory. Enter the full path to the plan as the argument to
--plan-dirto perform an installation.
the project was modified since the plan was generated, regenerate plan or skip this check with a --skip-health-check flag in the command
the certs were changed since the plan was generated, regenerate plan or skip this check with a --skip-health-check flag in the command
Getting help for commands
You can get help for all commands by entering:
apicup --help. Following is an
example of the output:
Getting help on a specific command
For help on a specific command, enter
--help after the command. For example,
apicup subsys get mgmt --help prints out the usage and flags for
get command. For example: