SaaS v2 documentation. Looking for the legacy version? See the SaaS v1 docs.

Configure a Connector with PyPI access: visualizations

In order for Moderne to retrieve your visualization artifacts from your PyPI repository, you will need to configure the Connector and run it in a specific environment. This guide will walk you through how to configure the Connector to achieve this.

Note: This feature is experimental. Running the Connector in an unsupported environment (read: os, python version) may break deployed visualizations.

Publishing visualizations

Visualization artifacts published to the configured PyPI index can be deployed to Moderne if there is a Connector configured with access.

Configuring the Moderne Connector

The following table contains all of the variables/arguments you need to add to your Moderne Connector run command in order for it to get visualization artifacts from your PyPI package index. Please note that these variables/arguments must be combined with ones found in other steps in the Configuring the Moderne Connector guide.

You can configure multiple PyPI indexes by including multiple entries, each with a different {index}.

OCI Container

Environment variables:

Variable Name	Required	Default	Description
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_URI	true		The URI of your PyPI package index.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_USERNAME	false	null	The username used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_PASSWORD	false	null	The password used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_BEARERTOKEN	false		The bearer token (access token) used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used. If bearerToken is specified, username and password must not be provided.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_SKIPSSL	false	false	Whether or not to skip SSL/TLS verification for calls from the Connector to this PyPI package index. This must be set to true if you use a self-signed SSL/TLS certificate.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_SKIPVALIDATECONNECTIVITY	false	false	By default, on Connector startup, we will validate that we can connect to this PyPI index, and fail to start up the Connector if we cannot. Set this to true to skip this validation.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_PROXY_HOST	false		The hostname of a proxy server to use for connections to this PyPI index.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_PROXY_PORT	false		The port of the proxy server to use for connections to this PyPI index.
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_CONNECTTIMEOUT	false	30s	Timeout for the connection to be established (and the first data received). Specified as a duration (e.g., 30s, 1m).
MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_{index}_READTIMEOUT	false	60s	Timeout for reading the response body from the PyPI package index. Specified as a duration (e.g., 60s, 5m).

Example:

docker run \
# ... Existing variables
-e MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_0_URI=https://pypi.example.com/simple \
-e MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_0_USERNAME=admin \
-e MODERNE_RECIPE_MARKETPLACE_REPOSITORIES_PYPI_0_PASSWORD=password \
# ... Additional variables

Executable JAR

Arguments:

Argument Name	Required	Default	Description
--moderne.recipe.marketplace.repositories.pypi[{index}].uri	true		The URI of your PyPI package index.
--moderne.recipe.marketplace.repositories.pypi[{index}].username	false	null	The username used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used.
--moderne.recipe.marketplace.repositories.pypi[{index}].password	false	null	The password used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used.
--moderne.recipe.marketplace.repositories.pypi[{index}].bearerToken	false		The bearer token (access token) used to access the index. Note: Only one of basic auth (username+password) or bearer token can be used. If bearerToken is specified, username and password must not be provided.
--moderne.recipe.marketplace.repositories.pypi[{index}].skipSsl	false	false	Whether or not to skip SSL/TLS verification for calls from the Connector to this PyPI package index. This must be set to true if you use a self-signed SSL/TLS certificate.
--moderne.recipe.marketplace.repositories.pypi[{index}].skipValidateConnectivity	false	false	By default, on Connector startup, we will validate that we can connect to this PyPI index, and fail to start up the Connector if we cannot. Set this to true to skip this validation.
--moderne.recipe.marketplace.repositories.pypi[{index}].proxy.host	false		The hostname of a proxy server to use for connections to this PyPI index.
--moderne.recipe.marketplace.repositories.pypi[{index}].proxy.port	false		The port of the proxy server to use for connections to this PyPI index.
--moderne.recipe.marketplace.repositories.pypi[{index}].connectTimeout	false	30s	Timeout for the connection to be established (and the first data received). Specified as a duration (e.g., 30s, 1m).
--moderne.recipe.marketplace.repositories.pypi[{index}].readTimeout	false	60s	Timeout for reading the response body from the PyPI package index. Specified as a duration (e.g., 60s, 5m).

Example:

java -jar connector-{version}.jar \
# ... Existing arguments
--moderne.recipe.marketplace.repositories.pypi[0].uri=https://pypi.example.com/simple \
--moderne.recipe.marketplace.repositories.pypi[0].username=admin \
--moderne.recipe.marketplace.repositories.pypi[0].password=password \
# ... Additional arguments

The Connector environment

To install pip packages from the secure environment the Connector runs in we need to first install the packages on the Connector and then move the packages to the SaaS. To achieve this the environments that the Connector and the SaaS run in must be in sync. You will need to ensure that the environment the Connector runs in is set up in a way that the python packages downloaded on the Connector will also work on the SaaS. This means:

• Linux (ubuntu:22.04 is tested)
• /bin/sh shell with
  • Python version 3.11 available under the python3 command
  • Pip and virtualenv (venv) installed. Alias not required (called via python3 -m pip/venv)
• A temporary directory will be used to download pip packages to. This uses the location defined in java.io.tmpdir. This location needs to be writable.
• The temporary directory has enough space to download the required packages.

note

This is not required if you do not wish to install visualizations from your own PyPI package index.