.. _configurations:

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

The Configurations page allows you to generate a Personal Access Token and add/remove Sparkling Water Python environments.

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

.. _personal-access-token:

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

Personal access tokens can be used in scripts and on the command line instead fo using your regular password.
**Note**: Be careful, these tokens are like passwords so you should guard them carefully.
The advantage to using a token over putting your password into a script is that a token can 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.
   For security reasons the token will be shown only once after generating.
   If you lose your token, you must generate a new one. You can only have one token at a time.

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

.. _python-environments:

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.