.. _configurations:

Configurations
==============

The Configurations page allows you to generate a Personal Access Token, set Minio credentials (when enabled) and add/remove Sparkling Water Python environments.

.. figure:: images/configurations.png
   :alt: Configurations page

.. _personal-access-token:

Personal Access Token
---------------------

Personal access tokens (PATs) are an alternative to using passwords for authentication to Enterprise Steam when using the API or the command line.
**Note**: Treat your tokens like passwords and keep them secret.
When working with the API, use tokens as environment variables instead of hardcoding them into your programs.
For security reasons, after you navigate off the page, you will not be able to see the token again.
When you generate a new token, any previously issued tokens will be revoked.

1. Click on **Tokens** under the API section to open the **Personal Access Token** page.
2. Click **Generate New Token** to generate and retrieve your token.

.. figure:: images/configurations-token.png
    :alt: Personal access token page

.. _python-environments:

Minio
-----

When Minio access has been configured by Steam administrator you have an option to enter your Minio Access and Secret key.

Driverless AI instances will have access to Minio buckets based on your credentials.

.. figure:: images/configurations-minio.png
    :alt: Minio page

Python Environments
-------------------

The Python Environments page shows the available Python environments when using Sparkling Water.
Enterprise Steam ships with two default environments - Python 2.7 and Python 3.7.

.. figure:: images/configurations-python.png
    :alt: Python Environments page

Adding Python Environments
~~~~~~~~~~~~~~~~~~~~~~~~~~

With Enterprise Steam, you can add a new Python environment from a Python path or from a Conda package.

.. figure:: images/configurations-python-add.png
   :alt: Add Python environment
   :scale: 38%

Conda Pack
''''''''''

Perform the following steps to add a new Python environment packaged as Conda pack.

**Note**: The OS type where the environment was built must match the OS type of the target machine.

1. On the Python Environments page, click **Add Environment**.
2. Select **Conda pack** from the Environment Type dropdown menu.
3. Enter a unique name for this new environment.
4. Upload the Conda pack archive file.
5. Click **Add Environment** when you are done.

Pythonpath
''''''''''

Perform the following steps to add a new Python environment via a Pythonpath.

1. On the Python Environments page, click **Add Environment**.
2. Select **Python path** from the Environment Type dropdown menu.
3. Enter a unique name for this new environment.
4. Specify the PySpark Python path.
5. Click **Add Environment** when you are done.

Deleting Python Environments
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Note**: The default environments cannot be deleted.

Click the **Actions > Remove** option beside the Python environment that you want to delete.
A confirmation message will display. Click **Confirm** to complete the removal.