Web Services

Create a YAML Configuration File

For the deployment of the web services, you need to prepare a YAML configuration file to tailor your Network Locator deployment to the specifics of you own environment.

Copy the following into a file named values.yaml and adapt all the <VARIABLES> to match your environment.

 

global:
 # Name of the Ingress controller class
 ingressClassName: <ingress-controller-classname>
 
 # Name of the TLS secret for securing communications
 tlsSecretName: <tls-secret>
 
 arcgis:
   # Base URL for the ArcGIS Enterprise
   enterpriseUrl: <ENTERPRISE-BASE-URL>
 
   # URL for the ArcGIS Portal, dynamically generated from enterpriseUrl.
   # Only change if you are not using the default URL patterns
   portalUrl: "{{ tpl .Values.global.arcgis.enterpriseUrl . }}/portal"
 
   # URL for the ArcGIS Server, dynamically generated from enterpriseUrl.
   # Only change if you are not using the default URL patterns
   serverUrl: "{{ tpl .Values.global.arcgis.enterpriseUrl . }}/server"
 
   # ArcGIS Portal username (requires at least an EDITOR User Type)
   portalUsername: <PORTAL-USER-NAME>
 
   # Password for the ArcGIS Portal user
   portalPassword: <PORTAL-USER-NAME-PASSWORD>
 
   # ID of the web map to use for initial configuration
   webMapId: <WEBMAP-ID>
 
 # Specify the hostname of your Kubernetes cluster
 hostname: <HOSTNAME-KUBERNETES-CLUSTER>
 
 cockpit:
   # URL of the Network Locator's Cockpit Client
   appUrl: <STUDIO-WEB-APP-COCKPIT-URL>
 
 landingPage:
   # URL of the Network Locator's Web Client
   appUrl: <STUDIO-WEB-APP-LOCATOR-URL>
 
 mailer:
   # Mail server configuration for sending automated emails
   host: <HOSTNAME-MAIL-SERVER>
   
   # Whether SSL is used for mail server communication
   ssl: false
 
   # StartTLS setting (OPTIONAL)
   startTls: OPTIONAL
 
   # Mail server connection settings
   port: 587
   username: <USERNAME-MAIL-SERVER>
   password: <PASSWORD-MAIL-SERVER>
   
   # Sender's email address
   from: <FROM-MAIL-ADDRESS>
 
 registry:
   # VertiGIS container registry details
   url: vertigisapps.azurecr.io
   username: <USER-NAME>
   password: <PASSWORD>

### IMPORTANT SETTINGS TO BE SET AND ACTIVATED BEFORE RE-INSTALLING THE CHART ###

# keycloak:
#   enableRealmImport: false

###    

 

 kubernetesDashboard:

 # Enable or disable the deployment of the Kubernetes Dashboard

   enableDeployment: false

    # Restrict the Dashboard's access to the namespace it runs in

   restrictToNamespace: true
 
keycloak:
 image:
   # URL of the VertiGIS container registry
   registry: vertigisapps.azurecr.io
 
 ingress:
   # Ingress class name for Keycloak Ingress configuration
   ingressClassName: <INGRESS-CONTROLLER-CLASSNAME>
 
 auth:
   # Keycloak admin credentials
   adminUser: <ADMIN-USERNAME>
   adminPassword: <ADMIN-PASSWORD>
 
 postgresql:
   auth:
     # Custom database user credentials
     username: <USERNAME>
     password: <PASSWORD>
 
     # Password for the "postgres" admin user
     postgresPassword: <PASSWORD>

 
 
kubernetes-dashboard:
 app:
   settings:
     global:
       # Set the default namespace for the Kubernetes Dashboard if you decide to deploy it
       defaultNamespace: <NAMESPACE>

 

 

Create Kubernetes Deployment

For the final deployment execute the following commands:

helm install
  <release-name>
  oci://vertigisapps.azurecr.io/network-locator/helm-chart
  --namespace <name of kubernetes namespace>
  -f values.yaml
  --wait  
  --version 1.2.0

This command may take up to five minutes to complete.

kubectl get pods -n <name of kubernetes namespace>

After executing this command, you should a screen similar to that in the figure below.

You have now successfully deployed the Network Locator Web Services. You can now proceed with the configuration of the solution.