Configuration reference (AER 2.26) — Anaconda Enterprise 4.4 documentation

Anaconda Enterprise: Documentation

# Configuration reference (AER 2.26)

- Usernames
  - USER_REGEX
- Database
  - MONGO_URL
  - MONGO_DBNAME
  - MQ_DBNAME
  - MONGO_REPLICA_SET
- File storage
  - storage_type
  - fs_storage_root
  - PACKAGE_BUCKET_ID
- Notebooks
  - MAX_IPYNB_SIZE
- Web server
  - SERVER_NAME
  - port
  - subdomains
  - SESSION_COOKIE_DOMAIN
  - USER_CONTENT_DOMAIN
  - ssl_options
    - certfile
    - keyfile
  - PREFERRED_URL_SCHEME
  - gunicorn
    - timeout
    - workers
- Authentication
  - AUTH_TYPE
  - KRB5_HOSTNAME
  - KRB5_SERVICE_NAME
  - KRB5_KTNAME
  - LDAP
- Email
  - SMTP_HOST
  - SMTP_PORT
  - SMTP_TLS
  - SMTP_USERNAME
  - SMTP_PASSWORD
  - USE_SES
  - RETURN_ADDRESS
  - ALLOW_DUPLICATED_EMAILS
  - require_email_validation
- Advanced
  - PARCELS_ROOT
  - PARCEL_DISTRO_SUFFIXES
  - DEFAULT_CHANNELS

Anaconda Repository will load configuration files with the extension `.yaml` from the following locations:

- `/etc/binstar/`
- `/etc/anaconda-server/`
- `$PREFIX/etc/anaconda-server`

`$PREFIX` is the location where Anaconda Repository was installed.

Files are loaded from these directories in order, with later files overriding earlier files. Files are loaded from each directory in alphabetical order.

Each configuration setting variable can have its value set with the `anaconda-server-config --set` command, or by editing a configuration file.

For example, you can set a value named VALUE_ONE to 50 by adding this to a configuration file:

    VALUE_ONE: 50

Or you can set a value named VALUE_ONE to 50 with this command:

    anaconda-server-config --set VALUE_ONE 50

## Usernames

### USER_REGEX

A regular expression that defines the allowable user names.

For example, this setting specifies that user names will contain only lowercase letters and the period, plus, and minus characters (`.` `+` and `-`):

    USER_REGEX: '^[a-z.+-]+$'

NOTE: Escape any extra instances of the single quote character `'` as `\'`, and do not use the slash and ampersand characters `/` and `&` which have special meanings in URLs.

NOTE: If USER_REGEX is changed and the server is restarted, existing usernames that do not match the new USER_REGEX will not cause errors.

## Database

Anaconda Repository uses MongoDB as the database backend.

### MONGO_URL

A MongoDB connection URI used to connect to the MongoDB database server. It can be used to configure the hostname and port, as well as database authentication.

For example:

    MONGO_URL: mongodb://anaconda-server:Pa55w0rd@mongodb.serv/

### MONGO_DBNAME

The MongoDB database where Anaconda Repository will store its data.

### MQ_DBNAME

The MongoDB database where Anaconda Repository will store data used for asynchronous processing.

### MONGO_REPLICA_SET

The name of a MongoDB replica set Anaconda Repository will connect to after establishing a connection to the database server.

## File storage

Anaconda Repository can serve package contents from a local file-system, or from Amazon Web Services Simple Storage Service (AWS S3).

### storage_type

The storage mechanism to use. Valid choices are `fs` (for file-system storage) or `s3` (for AWS S3 storage).

### fs_storage_root

The absolute path to a directory where Anaconda Repository will store all uploaded packages, if configured to use file-system storage.

### PACKAGE_BUCKET_ID

The name of an AWS S3 bucket where Anaconda Repository will store uploaded packages, if configured to use AWS S3 storage.

You can identify the name of your bucket by the `<bucket>` in your `http://<bucket>.s3.amazonaws.com` URL.

## Notebooks

### MAX_IPYNB_SIZE

This is the maximum allowed size when uploading notebooks to the server. The default is 25 MB. This variable can be set in `config.yaml`.

## Web server

### SERVER_NAME

The name and port number of the server. This option is required for subdomain support.

For example:

    SERVER_NAME: anaconda.srv:8080

### port

The port number of the server. Defaults to `8080`.

### subdomains

If set to `true`, Anaconda Repository will serve `conda` package from a separate subdomain. Defaults to `false`.

For example:

    SERVER_NAME: anaconda.srv:8080
    subdomains: true

Allows access to conda packages at `http://conda.anaconda.srv:8080/`.

### SESSION_COOKIE_DOMAIN

The domain that Anaconda Repository will set on the session cookie. If this is not set, the cookie will be valid for all subdomains of `SERVER_NAME`. See here.

### USER_CONTENT_DOMAIN

As a cross-site scripting (XSS) protection, notebook content can be served from a separate domain name. If this option is configured, Anaconda Repository will only serve rendered notebooks from this domain.

See here.

### ssl_options

Anaconda Repository can serve content over HTTPS, using user-provided SSL certificates.

For example:

    ssl_options:
        certfile: /etc/anaconda-server/server.crt
        keyfile: /etc/anaconda-server/server.key
    PREFERRED_URL_SCHEME: https

#### certfile

The absolute path to a PEM-formatted X.509 certificate file.

#### keyfile

The absolute path to a PEM-formatted private key for the associated certificate.

### PREFERRED_URL_SCHEME

The preferred scheme that will be used to generate URLs. Set this to `https` if HTTPS is configured.

### gunicorn

Anaconda Repository uses Gunicorn. The most commonly used options are `timeout` and `workers`. A complete list of settings can be found in Gunicorn’s documentation.

For example:

    gunicorn:
        timeout: 60
        workers: 5

#### timeout

The number of seconds that a worker is allowed to process a request for, before being forcefully terminated. Defaults to 30.

#### workers

The number of workers that gunicorn will spawn to serve Anaconda Repository. Defaults to 2 × the number of CPUs + 1.

## Authentication

### AUTH_TYPE

The method Anaconda Repository will use to authenticate users. Valid choices are `NATIVE` (for built-in authentication), `KERBEROS` (for Kerberos) and `LDAP`.

### KRB5_HOSTNAME

See Kerberos Configuration Options.

### KRB5_SERVICE_NAME

See Kerberos Configuration Options.

### KRB5_KTNAME

See Kerberos Configuration Options.

### LDAP

Options for configuring LDAP authentication and group synchronization.

For example:

    LDAP:
        URI: ldap://ldap.server
        BIND_DN: cn=Anaconda Repository,cn=Users,dc=example,dc=com
        BIND_AUTH: Pa55w0rd

        USER_SEARCH:
            base: cn=Users,dc=example,dc=com
            filter: sAMAccountName=%(username)s

        KEY_MAP:
            name: cn

See LDAP and TLS Configuration Options.

## Email

Anaconda Repository can be configured to send email for various reasons, including to reset forgotten usernames and passwords. Email can be sent using SMTP protocol, or through Amazon Web Services Simple Email Service (AWS SES).

### SMTP_HOST

The hostname of the SMTP server.

### SMTP_PORT

The port of the SMTP server.

### SMTP_TLS

If set to `true`, Anaconda Repository will attempt an SSL connection to the SMTP server.

### SMTP_USERNAME

The username to authenticate against the SMTP server before attempting to send email.

### SMTP_PASSWORD

The password to authenticate against the SMTP server before attempting to send email.

### USE_SES

If set to `true`, Anaconda Repository will send email with AWS SES. To authenticate to AWS, the server should be configured with an appropriate IAM role, or have credentials specified in a Boto configuration file.

### RETURN_ADDRESS

The `From:` email address that Anaconda Repository will use as sender.

### ALLOW_DUPLICATED_EMAILS

If set to `true`, Anaconda Repository will allow different users to share the same email or secondary email. Defaults to `false`

### require_email_validation

If set to `true`, Anaconda Repository will email new users a unique token to validate their email address before permitting them to log in.

## Advanced

### PARCELS_ROOT

The prefix that Cloudera parcels are generated with. Defaults to `/opt/cloudera/parcels`.

### PARCEL_DISTRO_SUFFIXES

The distributions that Cloudera parcels are generated for. Defaults to `['el5', 'el6', 'el7', 'lucid', 'precise', 'trusty', 'wheezy', 'jessie', 'squeeze', 'sles11', 'sles12']`.

For example, if you only wish to support Ubuntu:

    PARCEL_DISTRO_SUFFIXES:
        - lucid
        - precise
        - trusty

### DEFAULT_CHANNELS

The Anaconda Repository accounts that environments installed with the bundled Anaconda distributions will pull packages from. Defaults to `['anaconda', 'r-channel']`.

For example, to add an additional `custom` account:

    DEFAULT_CHANNELS:
        - anaconda
        - r-channel
        - custom