Configure ArcGIS Enterprise on Kubernetes Web Adaptor

After you install ArcGIS Enterprise on Kubernetes Web Adaptor, you must configure it to work with your organization. You can configure it using a wizard or command line utility.

Note:
The configuration wizard and command line utility can only be accessed from the machine hosting ArcGIS Enterprise on Kubernetes Web Adaptor.

Configure your organization with ArcGIS Enterprise on Kubernetes Web Adaptor

To configure your organization with ArcGIS Enterprise on Kubernetes Web Adaptor, do the following:

  1. Deploy ArcGIS Enterprise on Kubernetes.
  2. Create an organization.
  3. Install ArcGIS Enterprise on Kubernetes Web Adaptor
  4. Obtain the Web Adaptor registration token.
  5. Use the configuration wizard or command line tool to provide the registration token to ArcGIS Web Adaptor.

Obtain the registration token

The registration token is a unique set of letters and numbers that is decoded by ArcGIS Enterprise on Kubernetes Web Adaptor and used to register a web or application server with your organization.

Once you've deployed ArcGIS Enterprise on Kubernetes and created an organization, you can obtain a registration token from ArcGIS Enterprise Manager or by using a command line utility.

Obtain the registration token from ArcGIS Enterprise Manager

To obtain the registration token from ArcGIS Enterprise Manager, complete the following steps:

  1. Sign in to ArcGIS Enterprise Manager as an administrator.
  2. Click Settings, and click Web Adaptor.
  3. Click Copy.
    Note:

    For registration of multiple instances of ArcGIS Enterprise on Kubernetes Web Adaptor, a unique registration token is required for each. A new token is generated each time Copy is clicked.

Next, you'll use the registration token to configure with ArcGIS Enterprise on Kubernetes Web Adaptor.

Obtain the registration token using the command line

If ArcGIS Enterprise Manager is not available through the node port on a worker node in a browser, the registration token can be obtained using a command line utility.

To obtain the registration token, complete the following steps:

  1. On your Kubernetes client machine, open a terminal.
  2. Run the get-registration-token.sh tool using the following command format, entering the username and password when prompted:
    ./get-registration-token.sh -w node.example.com -c context -n 31443
    
  3. Copy the registration token and transfer it to the Web Adaptor host machine.

Next, you'll use the registration token to configure with ArcGIS Enterprise on Kubernetes Web Adaptor.

Use the configuration wizard

To configure ArcGIS Enterprise on Kubernetes Web Adaptor from the configuration wizard, complete the following steps:

  1. Open the configuration wizard in a browser.

    The URL is in the format https://organization.example.com/context/webadaptor.

  2. On the Welcome page, click Continue.
  3. On the Configure page, paste your registration token in the text box and click Configure.

    ArcGIS Enterprise on Kubernetes Web Adaptor is now configured. You can access ArcGIS Enterprise Manager and the organization at the URLs provided on the page. When you are finished, close the browser window.

Use the command line

A command line utility is available to configure ArcGIS Enterprise on Kubernetes Web Adaptor silently. Steps to run the command line utility are provided for each installation type (IIS and Java).

ArcGIS Enterprise on Kubernetes Web Adaptor (IIS)

The ArcGIS Enterprise on Kubernetes Web Adaptor (IIS) command line utility is located in the same location where the Web Adaptor file was extracted.

Note:
The default location is C:\Program Files (x86)\Common Files\ArcGIS\WebAdaptorKubernetes\IIS\<version>\Tools\ConfigureWebAdaptor.exe.

The available parameters are as follows:

-t <WebAdaptorRegistrationToken> -w <WebAdaptorMachineName> -h <help>

  • <WebAdaptorRegistrationToken>—The registration token is used to configure ArcGIS Web Adaptor with your organization and can be obtained from ArcGIS Enterprise Manager, ArcGIS Enterprise Administrator API, or by using a command line utility.
  • <WebAdaptorMachineName>—(Optional) The name of the machine hosting the ArcGIS Enterprise on Kubernetes Web Adaptor. Include the fully qualified domain name of the machine, for example, webadaptorhost.domain.com. Alternatively, use the URL of the Web Adaptor you want to configure. This is the same URL that would be used if you were accessing the Web Adaptor configuration page in a web browser.
  • <help>—(Optional) Displays help for the utility.

Example:

C:\Program Files (x86)\Common Files\ArcGIS\WebAdaptorKubernetes\IIS\<version>\Tools>ConfigureWebAdaptor.exe -t abCdeFGhIJKLMNopQrIstuV1wX2YzA3BCDeFGHI4jkLMnOpQrSTU5V678WXyZABcde9fgHIJKlmN0PQrstuvwX1Yza2BCd3E4fghiJkL4MNOpQRStu5WXyzA6BcDeFGHiJKLmNOp7QrStuvwxY89zAB0cdeFgHIJklMNopQr1stu2vWXyZa3bCDE4FGHiJkl5MN6op7QrStUvwX8yzABcdefgh9ijklM0nOPqrstuVWXYZABCdEfgHIjKlMnOP1qrST2UVwxYZaBCDEFGH3ijKLMNOp4qRSTUVwXyZAB5c6d7EFghi890jKL1MNoPQRStUvW2xYzaBCDef34ghiJ5KLM6NOP7QRS8TUVwXy9zA0lbCdefGHIjK2M3Nop4QRSTU5VWXyZ6 -w https://<webadaptorhost.domain.com>/arcgis/webadaptor

After running the command, ArcGIS Enterprise on Kubernetes Web Adaptor is configured with your organization.

ArcGIS Enterprise on Kubernetes Web Adaptor (Java) for Windows

The ArcGIS Enterprise on Kubernetes Web Adaptor (Java) command line utility is in the same location where the Web Adaptor file was extracted.

The available parameters are as follows:

-t <WebAdaptorRegistrationToken> -w <WebAdaptorMachineName> -h <help>

  • <WebAdaptorRegistrationToken>—The registration token is used to configure ArcGIS Web Adaptor with your organization and can be obtained from ArcGIS Enterprise Manager, ArcGIS Enterprise Administrator API, or by using a command line utility.
  • <WebAdaptorMachineName>—(Optional) The name of the machine hosting the ArcGIS Enterprise on Kubernetes Web Adaptor. Include the fully qualified domain name of the machine, for example, webadaptorhost.domain.com. Alternatively, use the URL of the Web Adaptor you want to configure. This is the same URL that would be used if you were accessing the Web Adaptor configuration page in a web browser.
  • <help>—(Optional) Displays help for the utility.

Example:

ConfigureWebAdaptor.bat -t abCdeFGhIJKLMNopQrIstuV1wX2YzA3BCDeFGHI4jkLMnOpQrSTU5V678WXyZABcde9fgHIJKlmN0PQrstuvwX1Yza2BCd3E4fghiJkL4MNOpQRStu5WXyzA6BcDeFGHiJKLmNOp7QrStuvwxY89zAB0cdeFgHIJklMNopQr1stu2vWXyZa3bCDE4FGHiJkl5MN6op7QrStUvwX8yzABcdefgh9ijklM0nOPqrstuVWXYZABCdEfgHIjKlMnOP1qrST2UVwxYZaBCDEFGH3ijKLMNOp4qRSTUVwXyZAB5c6d7EFghi890jKL1MNoPQRStUvW2xYzaBCDef34ghiJ5KLM6NOP7QRS8TUVwXy9zA0lbCdefGHIjK2M3Nop4QRSTU5VWXyZ6 - w https://<webadaptorhost.domain.com>/arcgis/webadaptor

After running the command, ArcGIS Enterprise on Kubernetes Web Adaptor is configured with your organization.

ArcGIS Enterprise on Kubernetes Web Adaptor (Java) for Linux

You can configure ArcGIS Enterprise on Kubernetes Web Adaptor (Java) using the command line utility in the location where the Web Adaptor file was extracted.

The available parameters are as follows:

-t <WebAdaptorRegistrationToken> -w <WebAdaptorMachineName> -h <help>

  • <WebAdaptorRegistrationToken>—The registration token is used to configure ArcGIS Web Adaptor with your organization and can be obtained from ArcGIS Enterprise Manager, ArcGIS Enterprise Administrator API, or by using a command line utility.
  • <WebAdaptorMachineName>—(Optional) The name of the machine hosting the ArcGIS Enterprise on Kubernetes Web Adaptor. Include the fully qualified domain name of the machine, for example, webadaptorhost.domain.com. Alternatively, use the URL of the Web Adaptor you want to configure. This is the same URL that would be used if you were accessing the Web Adaptor configuration page in a web browser.
  • <help>—(Optional) Displays help for the utility.
Note:

To run the command line utility, the Java Runtime Environment (JRE) must be present on the machine hosting ArcGIS Web Adaptor. If the JRE is not present on the machine, an error occurs when running the utility. See the Java Downloads site for instructions on how to download and install the JRE on your machine.

Example:

./ConfigureWebAdaptor.sh -t abCdeFGhIJKLMNopQrIstuV1wX2YzA3BCDeFGHI4jkLMnOpQrSTU5V678WXyZABcde9fgHIJKlmN0PQrstuvwX1Yza2BCd3E4fghiJkL4MNOpQRStu5WXyzA6BcDeFGHiJKLmNOp7QrStuvwxY89zAB0cdeFgHIJklMNopQr1stu2vWXyZa3bCDE4FGHiJkl5MN6op7QrStUvwX8yzABcdefgh9ijklM0nOPqrstuVWXYZABCdEfgHIjKlMnOP1qrST2UVwxYZaBCDEFGH3ijKLMNOp4qRSTUVwXyZAB5c6d7EFghi890jKL1MNoPQRStUvW2xYzaBCDef34ghiJ5KLM6NOP7QRS8TUVwXy9zA0lbCdefGHIjK2M3Nop4QRSTU5VWXyZ6 -w https://<webadaptorhost.domain.com>/arcgis/webadaptor

After running the command, ArcGIS Enterprise on Kubernetes Web Adaptor is configured with your organization.