Back to Top

Create an organization

In this topic

  1. Use the setup wizard
  2. Use the configuration script

After you've deployed ArcGIS Enterprise on Kubernetes on your Kubernetes cluster, you must create an ArcGIS Enterprise organization. You can create an organization in one of two ways:

  • Use a browser to run the setup wizard
  • Use the configure.sh script to create an organization silently

The configuration script is included in the deployment package that is delivered as a .tar.gz file and available for download from My Esri.

Both options will do the following:

  • Download the Esri Docker images for ArcGIS Enterprise on Kubernetes
  • Deploy ArcGIS Enterprise on Kubernetes containers in your ArcGIS Enterprise on Kubernetes cluster
  • Create an ArcGIS Enterprise organization

Use the setup wizard

Once you've deployed ArcGIS Enterprise on Kubernetes, perform the following steps with the configuration wizard to complete your organization:

Open the Create New Organization link in a web browser. Browse to your load balancer URL and append /manager to the end of the URL. For example, if your load balancer context is arcgis, open the https://organization.example.com/arcgis/manager URL.

The page redirects to the ArcGIS Enterprise on Kubernetes setup wizard. Click Continue to begin. To complete the wizard, follow these steps:

  1. On the Architecture profiles page, select the profile that meets your organization's requirements and click Next.
  2. On the Provide license page, upload a ArcGIS Enterprise on Kubernetes license file and specify a user type for the primary administrator account:
    • Choose the license file (a .json file) that will license your organization's user types and apps. This file is obtained from My Esri.
    • Select the user type for the primary administrator account that you will create in the next step. You can change the administrator's user type in the portal after the organization is created.
    • Click Next.
  3. On the Create administrator account page, create a primary administrator account for your ArcGIS Enterprise organization. Provide a user name, password, email, first and last name, and a security question and answer, and click Next.

    Your user name must be at least six characters in length. The only special characters allowed are the at sign (@), dash (-), dot (.), and underscore (_).

    Your password must be at least eight characters in length. It must contain at least one alphabet letter (uppercase or lowercase) and one number. All special characters are allowed.

  4. On the Set system storage tab, specify storage specifications for your organization.
    1. Choose Dynamic or Static to specify how you're provisioning persistent volumes (PVs)

      • If you choose Dynamic, specify the following for each storage volume:
        • Size (required)—Specify the minimum size requirement. If you require larger storage volumes, increase the size accordingly.
        • Storage class name (required)—Specify your own storage class names. Optionally, check the box to use the same storage class name for all storage volumes.
        • Label selector (optional)—If you want to label your PVs, provide the key value pairs accordingly.
      • If you choose Static, specify the following for each storage volume:
        Note:

        When binding to an existing PV that has no storage class defined, leave the storage class name blank. If a default storage class is configured in the cluster, the DefaultStorageClass admission controller adds the default storage class and prevents the PVC from binding. In this case, administrators should either add a storage class specification to the PV or remove the default storage class configuration.

        • Size (required)—Specify the minimum size requirement. If you've provisioned your storage with larger volumes, increase the size accordingly.
        • Storage class name (optional)—If you've set a storage class, specify the storage class name for each volume. Optionally, check the box to use the same storage class name for all storage volumes.
        • Label selector (required)—Define labels by entering key value pairs accordingly. Example labels are provided in the system requirements.

    2. On the Set user managed storage tab, optionally, provide a registered data folder or set of folders for your organization. Once the organization is in use, members with publishing privileges can create items that directly reference the data within these registered locations.

      • File server host name—Provide the machine name where shared data is stored and accessed through a Network File System (NFS) path.
      • File server shared path—Provide an NFS path on the host machine where shared data can be stored and accessed across the organization.
      • Client path—Provide individual (drive or shared) locations where source data can be accessed and published by clients, such as ArcGIS Pro.

      To register more than one path, click Add more paths, specify the host name, shared path and client path, and repeat as needed.

    Note:

    It is strongly recommended that you register folders during this step, as the act of registering later is subject to system downtime.

    • Click Next.

    On the Configuration summary page, you're provided with a summary of configuration details.

  5. Review each item, and click Finish to start the setup.

While the wizard runs, it displays the current configuration status.

Use the configuration script

As an alternative to using the setup wizard, you can create an organization silently. Once you've deployed ArcGIS Enterprise on Kubernetes, you can run the configure.sh script.

Note:
It is recommended that you run the password-encrypt.sh tool to generate encrypted passwords for use in the configure.properties file.

Run the script

The configure.sh script is available for download from My Esri and is delivered as a .tar.gz file. The script is bundled with a configure.properties file, which provides a set of parameters prompting for unique input to your ArcGIS Enterprise organization and a password-encrypt.sh tool, which is used to generate AES-256 encrypted passwords

The configure.sh script does the following:

  • Verifies valid parameters in the configure.properties file
  • Creates a storage JSON based on provided storage properties found in the configure.properties file
  • Creates an ArcGIS Enterprise organization

Note:

The client workstation used to run this script must have access to https://<FQDN>/<context>/admin.

To run the script, do the following:

  1. On your Kubernetes client machine, open a terminal as an administrator.
  2. Browse to <ArcGIS Enterprise on Kubernetes install directory>/tools/configure.
  3. Open the configure.properties file.
  4. Provide values for each parameter listed in the file. The file is divided into the following sections:
    • Architecture profile
    • Organization
    • License
    • Encryption Keyfile
    • Administrator account
    • Log settings
    • Storage
  5. Save the file. Optionally, rename the file.
  6. In the terminal, run the configuration script using the following command format:
    ./configure.sh [options] -f <user_properties>

    • One of the options you can choose to run with the configuration script is the option to register user-managed data stores. If you choose to register a user-managed data store, you'll need to provide a data folder, or a set of data folders, for your organization in a .json file using the following format:
      Note:

      The example JSON below specifies the details for a network file share (NFS) with a client path that points to a network share, as well as a NFS with a client path that points to a local drive.

      [
  {
    "clientPath": "\\\\sample_server\\SharedPath\\Data",
    "type": "folder",
    "info": {
      "fileServerHost": "nfsHost.domain.com",
      "fileServerType": "nfs",
      "fileServerPath": "/SharedPath/Data"
    }
  },
  {
    "clientPath": "C:\\data",
    "type": "folder",
    "info": {
      "fileServerHost": "nfsHost.domain.com",
      "fileServerType": "nfs",
      "fileServerPath": "/data",
      "hostName": "yourclienthost.domain.com"
    }
  }
]
    • You will also need to append the path to the .json file to the command format in the following way:
      % ./configure.sh -f my.properties -u /path/to/my_data_stores.json

The contents of <user properties> are derived from the configure.properties file.

Once you've run the script, you'll be presented with a summary of configuration details and asked if you want to continue.

  • If you specify y for yes, the script proceeds and creates an organization. This is the default input the script assumes.
  • If you specify n for no, the script immediately exits and does not create an organization.

Feedback on this topic?

In this topic
  1. Use the setup wizard
  2. Use the configuration script