Alteryx Analytics Hub Knowledge Base

Definitive answers from Alteryx Analytics Hub experts.

How To: Configuring Alteryx Analytics Hub to Use Trusted Secure Certificates

ZacharyH
Alteryx
Alteryx
Created

Prerequisites

  1. Alteryx Analytics Hub
    • 2020.2.0+
  2. Administrator rights to the server running Alteryx Analytics Hub
  3. Windows PowerShell installed on the server running Alteryx Analytics Hub
  4. Alteryx Analytics Hub running on a single server. If you have remote workers, please contact support for further assistance.

 

Procedure – Installing Trusted Secure Certificates

 

1.    Launch Windows PowerShell in Administrator mode.

2.    Navigate to the root folder of your AAH install, for example:

PS C:\Windows\System32> cd ‘C:\Program Files\Alteryx\Alteryx Analytics Hub\’ 

3.    Execute the PowerShell script, ayxhub.ps1

USAGE:
ayxhub.ps1 -https enable
 [Path to certificate] 
 [Path to private key file]
 [Path to pfx archive]
 [Password to pfx archive]

Example:

PS C:\Program Files\Alteryx\Alteryx Analytics Hub> .\ayxhub.ps1 -https enable C:\ssl\host.domain.com.crt C:\ssl\host.domain.com.key C:\ssl\host.domain.com.pfx password

4.    To apply the changes, execute ayxhub.ps1 -restart

Example:

PS C:\Program Files\Alteryx\Alteryx Analytics Hub> .\ayxhub.ps1 -restart

 

At any time before you execute ayxhub.ps1 -restart, you can view pending changes in the settings.log file generated in \Alteryx Analytics Hub. If you wish to throw away these changes rather than deploy them, execute ayxhub.ps1 -pending remove

Once complete, examine your Settings.yml file. It will look like this:

  host:
    port: 443
  https:
    enable: true
    key_location: C:\ssl\host.domain.com.key
    cert_location: C:\ssl\host.domain.com.crt
...
internal_gateway:
  host:
    port: 8080
  https:
    enable: true
    cert_location: C:\ssl\host.domain.com.crt
    key_location: C:\ssl\host.domain.com.key
    ca_bundle: ""
    ca_password: ""
    ca_crt: ""
    ca_key: ""

 

CutlassSettings.yml should look like this:

https:
  enable: true
  encryption_key_path: C:\\ssl\\host.domain.com.pfx_encryption_key
  certificate_path: C:\\ssl\\host.domain.com.pfx
  certificate_password: <redacted>
  encrypted: true

 

Check and Update Worker Configuration

 

1.    Open CutlassSettings.yml in a text editor. 

2.    Examine the host.hostname property. It should NOT contain localhost:

host:
  port: 5000
  hostname: localhost <-- This is bad because localhost is no longer SSL-protected

 

3.    As necessary, update the hostname property to point to the fully qualified domain name (FQDN) of the server you are updating:

host:
  port: 5000
  hostname: host.domain.com <-- This is good

 

4.    Examine the ayxserver.hostname property. It should NOT contain localhost: 

ayxserver:
  internal_gateway_port: 8080
  protocol: https
  hostname: localhost <-- This is bad because localhost is no longer SSL-protected

5.    As necessary, update the hostname property to point to the fully qualified domain name (FQDN) of the computer running the Alteryx Analytics Hub core services: 

ayxserver:
  internal_gateway_port: 8080
  protocol: https
  hostname: host.domain.com <-- This is good.

6.    Save your changes. 

7.    If you modified CutlassSettings.yml, you must restart the Alteryx Engine Worker service.

Example:

PS C:\Program Files\Alteryx\Alteryx Analytics Hub> .\ayxhub.ps1 -restart

 

Known Issues

 

When configuring Alteryx Analytics Hub to use trusted secure certificates, if any of the certificates in the certification path are not trusted by Node.js or AXIOS version 12.13.1, you could receive the errors below:

1.     After installing a trusted secure certificate, when clicking “Test Connection” on a data source, I receive the following error message: “Request failed with status code 500” as shown below.

idea Skyscrapers

2.     When running an Analytic App in Alteryx Analytics Hub, upon clicking the “Run” button I receive an error stating “Couldn’t fetch questions. Contact your admin

idea Skyscrapers

If you receive either of these errors, proceed as follows to resolve the issue. The steps detailed below need to be completed on the server running the core services.

 

1.     Download the PowerShell script, set-certificates.ps1, included below.

2.     Copy set-certificates.ps1 to the Analytics Hub installation path.

o    The default location is C:\Program Files\Alteryx\Alteryx Analytics Hub.

3.     Launch Windows PowerShell in Administrator mode.

4.     In the PowerShell window, navigate to the Alteryx Analytics Hub installation path

Example:

PS C:\Windows\System32> CD ‘C:\Program Files\Alteryx\Alteryx Analytics Hub\’ 

5.     Execute the PowerShell script, set-certificates.ps1

USAGE:
set-certificates.ps1 
 [Path to certificate] 
 [Path to key file]
 [Path to bundle file]

Example:

PS C:\Program Files\Alteryx\Alteryx Analytics Hub> .\set-certificates.ps1 C:\ssl\host.domain.com.crt C:\ssl\host.domain.com.key C:\ssl\bundle.crt 

6.     Restart Alteryx Analytics Hub to apply the changes

PS C:\Program Files\Alteryx\Alteryx Analytics Hub> .\ayxhub.ps1 -restart

Additional Resources

Configure TLS (SSL)

Attachments
No ratings