manage create-proxy-config

Create the resources that are needed to provide your proxy configuration to Cloud Pak for Data.

Required role

Instance administrator An instance administrator can run this command.

Prerequisites

Before you run this command, a cluster administrator must install and enable the resource specification injection (RSI) webhook.

For more information about the commands to install and enable RSI, see:

Extended description

If you have a cluster-wide proxy configuration, you can use the create-proxy-config command to generate configuration resources that support the following types of connections:

  • httpProxy
  • httpsProxy
  • noProxy

After you create the proxy configuration resources, you must apply the configuration by running the cpd-cli manage enable-proxy command.

Syntax

cpd-cli manage create-proxy-config \
--cpd_instance_ns=<project-name> \
[--proxy_host=<proxy-server-hostname>] \
[--proxy_port=<proxy-server-port>] \
[--proxy_user=<proxy-server-username>] \
[--proxy_password=<proxy-server-password>] \
[-vv][-vv][-vvv]

Arguments

The create-proxy-config command has no arguments.

Options

Table 1: Command options
Option Description
--cpd_instance_ns The project (namespace) where you want to create or update the patch. If there are any projects tethered to this project, the patch will also apply to the tethered projects.
Status
Required.
Syntax
--cpd_instance_ns=<project-name>
Default value
No default. User-defined.
Valid values
The name of the project where you want to create the RSI feature. Cloud Pak for Data must be installed in this project.
--proxy_host The host name or IP address of your proxy server.
Status
Required.
Syntax
--proxy_host=<proxy-server-hostname>
Default value
No default.
Valid values
The host name or IP address of your proxy server.
--proxy_password The password of the specified proxy server user, if the proxy server requires authentication.
Status
Required if your proxy server requires authentication.
Syntax
--proxy_password=<proxy-server-password>
Default value
No default.
Valid values
The password of a user that can authenticate to the proxy server.
--proxy_port The port number to connect to on the proxy server.
Status
Required if you need to specify a port number to connect to your proxy server.
Syntax
--proxy_port=<proxy-server-port>
Default value
No default.
Valid values
The port number to connect to on the proxy server.
--proxy_user The name of a proxy server user, if the proxy server requires authentication.
Status
Required if your proxy server requires authentication.
Syntax
--proxy_user=<proxy-server-username>
Default value
No default.
Valid values
The name of a user that can authenticate to the proxy server.
-v
-vv
-vvv
 Display verbose output.

Options are listed from least verbose to the most verbose.

Status
Optional.
Syntax
Verbose output
-v
Very verbose output
-vv
Most verbose output
-vvv
Default value
Not applicable.
Valid values
Not applicable.

Examples

Note: The following example uses the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Setting up installation environment variables.

Create the configuration resources for an HTTP proxy server that does not require authentication
cpd-cli manage create-proxy-config \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--proxy_host=${PROXY_HOST} \
--proxy_port=${PROXY_PORT}
Create the configuration resources for an HTTP proxy server that requires authentication
cpd-cli manage create-proxy-config \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--proxy_host=${PROXY_HOST} \
--proxy_port=${PROXY_PORT} \
--proxy_user=${PROXY_USER} \
--proxy_password=${PROXY_PASSWORD}