alteryx-server Cookbook

A Chef cookbook to install and configure Alteryx Server.

Requirements

• windows - alteryx-server only supports the Windows platform.
• chef-client >= 12.7.2 - alteryx-server only supports chef-client versions of 12.7.2 or above.

Scope

Resources are the intended way to consume this cookbook, however we've provided a couple of example recipes that install, configure, and license a standalone server.

Recipes

default

The default recipe downloads, installs, and configures Alteryx Server as well as Alteryx R Predictive Tools.

license

This recipe licenses Alteryx Server and starts AlteryxService.

Limitations

• No functionality exists to check if the desired license is already activated. Use the node['alteryx']['license']['skip'] attribute or the skip property in the alteryx_server_license resource to skip activation.
• mongo_db_search_password_encrypted and mongo_db_web_password_encrypted cannot be set through secrets property in the alteryx_server_runtimesettings resource. To set these connections, one either has to configure them through the configuration GUI or put them in plain text in mongo_db_search_override and mongo_db_web_override, respectively.

Resources

alteryx_server_package

Actions: :install, :uninstall

Install Alteryx Server.

Attributes

Examples:

# Install latest version of Alteryx Server
alteryx_server_package 'Alteryx Server'

# Install specified version of Alteryx Server
alteryx_server_package 'Alteryx Server' do
  source 'http://downloads.alteryx.com/Alteryx11.5.1.31573/AlteryxServerInstallx64_11.5.1.31573.exe'
  version '11.5.1.31573'
end

# Uninstall Alteryx Server
alteryx_server_package 'Alteryx Server' do
  action :uninstall
end

alteryx_server_license

Actions: :activate

Activate an Alteryx Server license.

Important: Each node must have a unique e-mail address for the license key, otherwise the license seat will be moved to whichever node licensed the seat last.

Attributes

Examples

# Replace xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx with your key
alteryx_server_license 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' do
  email 'test@example.com'
end

# Replace xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx with your key
alteryx_server_license 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' do
  email 'test@example.com'
  skip true
end

alteryx_server_service

Actions: :disable, :enable, :manual, :restart, :start, :stop

Stop/start/restart the AlteryxService and manage automatic start on boot.

Examples:

# Set service `Startup Type` to `Automatic`.
alteryx_server_service 'AlteryxService'

# Set service `Startup Type` to `Automatic`.
alteryx_server_service 'AlteryxService' do
  action :enable
end

# Set service `Startup Type` to `Disabled`.
alteryx_server_service 'AlteryxService' do
  action :disable
end

# Set service `Startup Type` to `Manual`.
alteryx_server_service 'AlteryxService' do
  action :manual
end

# Restart the AlteryxService.
alteryx_server_service 'AlteryxService' do
  action :restart
end

# Start the AlteryxService.
alteryx_server_service 'AlteryxService' do
  action :start
end

# Stop the AlteryxService.
alteryx_server_service 'AlteryxService' do
  action :stop
end

# Enable and start the AlteryxService.
alteryx_server_service 'AlteryxService' do
  action [:enable, :start]
end

alteryx_server_r_package

Actions: :install, :uninstall

Install R Predictive Tools for Alteryx Server.

Attributes

Examples:

# Install latest version of R Prodictive Tools
alteryx_server_r_package 'R Predictive Tools'

# Install specified version of R Prodictive Tools
alteryx_server_r_package 'R Predictive Tools' do
  source 'http://downloads.alteryx.com/Alteryx11.5.1.31573/RInstaller_11.5.1.31573.exe'
  version '3.3.2'
end

# Uninstall Alteryx Server
alteryx_server_package 'Alteryx Server' do
  action :uninstall
end

alteryx_server_runtimesettings

Actions: :manage

Configure RuntimeSettings overrides.

Attributes

config options

The config attribute by default will look for settings under node['alteryx']['runtimesettings']. The recommended way to configure properties in RuntimeSettings.xml is to set attributes per node or per role under node['alteryx']['runtimesettings']. To disable the controller, for example, add the following line to attributes/default.rb:
ruby
default['alteryx']['runtimesettings']['controller']['controller_enabled'] = false


One could also achieve the same result by passing a hash directly to alteryx_server_runtimesettings. See the example below.

Examples:

alteryx_server_runtimesettings 'RuntimeSettings.xml'

alteryx_server_runtimesettings 'Configure RuntimeSettings' do
  config(
    controller: {
      controller_enabled: false,
      logging_enabled: true,
      logging_path: 'C:\\Some\\Log\\File.log'
    },
    worker: {
      thread_count: 8
    }
  ),
  secrets(
    execute_user: {
      user: node['alteryx']['runtimesettings']['worker']['execute_user_name'],
      domain: node['alteryx']['runtimesettings']['worker']['execute_domain'],
      password: 'somesupersecretexecutepassword'
    },
    mongo_password: 'somesupersecretmongopassword',
    remote_secret: 'thecontrollerssecret',
    server_secret: 'thelocalserversecret',
    smtp_password: 'somesupersecretsmtppassword'
  )
  restart_on_change true
end

Options

controller options

The following contains available options and descriptions for child settings under the controller attribute.

engine options

The following contains available options and descriptions for child settings under the engine attribute.

gallery options

The following contains available options and descriptions for child settings under the gallery attribute.

worker options

The following contains available options and descriptions for child settings under the worker attribute.

Testing

Refer to TESTING.md.

Contributing

Refer to CONTRIBUTING.md.

License

This software is licensed under the Apache 2 license, quoted below.

Copyright (c) 2016 Alteryx, Inc. 

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.