diff --git a/docs/source/teams/api_connection.rst b/docs/source/teams/api_connection.rst index 51bca5e2b8..f8f5fb6f38 100644 --- a/docs/source/teams/api_connection.rst +++ b/docs/source/teams/api_connection.rst @@ -19,6 +19,8 @@ dataset permissions *are enforced*. is to use your Teams deployment's :ref:`MongoDB connection `. +.. _configuring-an-api-connection: + Configuring an API connection ----------------------------- diff --git a/docs/source/teams/teams_plugins.rst b/docs/source/teams/teams_plugins.rst index b2486f8aa3..bc6289c9f4 100644 --- a/docs/source/teams/teams_plugins.rst +++ b/docs/source/teams/teams_plugins.rst @@ -464,40 +464,39 @@ to: `FiftyOne Airflow DAG `_ - You're all set. Schedule those operations! -The required environment variables are: - -.. code-block:: bash - - # Configure where plugins source lives - export FIFTYONE_PLUGINS_DIR=... # eg /mnt/nfs/shared/plugins - - # Configure where media and models will be downloaded - export FIFTYONE_MEDIA_CACHE_DIR=... - export FIFTYONE_MEDIA_CACHE_SIZE_BYTES=... - export FIFTYONE_MODEL_ZOO_DIR=... - - # - # Copy the values below from your Teams deployment - # - - # Provide your encryption key so the orchestrator can access secrets - export FIFTYONE_ENCRYPTION_KEY=... - export FIFTYONE_INTERNAL_SERVICE=1 - - # If your deployment uses API connections - export FIFTYONE_API_KEY=... - export FIFTYONE_API_URL=... - - # If your deployment uses direct mongo connections - export FIFTYONE_DATABASE_NAME=... - export FIFTYONE_DATABASE_URI=... - export FIFTYONE_API_KEY=... - export API_URL=... +There are some required configurations. For information on other optional +configurations, see :ref:`Configuring FiftyOne `. + ++---------------------------+----------------------+--------------------------------------------------------------------+ +| Environment Variable | JSON Config Variable | Purpose | ++===========================+======================+====================================================================+ +| API_URL | N/A | The URL of the :ref:`API endpoint ` | +| | | | +| | | Note this is distinct from the `FIFTYONE_API_URL` variable which | +| | | will make FiftyOne use API connection mode for all operations. | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_API_KEY | api_key | The API key of an admin user that is used like a service account, | +| | | to resolve secrets and check permissions | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_DATABASE_URI | database_uri | The MongoDB database URI. Should match the deployment value. | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_DATABASE_NAME | database_name | Optional. The MongoDB database name, if different from the | +| | | default `fiftyone`. | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_ENCRYPTION_KEY | N/A | Encryption key used for decrypting and injecting secrets into | +| | | operator runs. Must match the deployment's value. | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_INTERNAL_SERVICE | N/A | Set to 1 always. ``export FIFTYONE_INTERNAL_SERVICE=1`` | ++---------------------------+----------------------+--------------------------------------------------------------------+ +| FIFTYONE_PLUGINS_DIR | plugins_dir | Path to plugins source code directory. | ++---------------------------+----------------------+--------------------------------------------------------------------+ .. note:: Refer to :ref:`this section ` for more - information on media caching in FiftyOne Teams. + information on media caching and access in FiftyOne Teams. Make sure that + cloud storage permissions are configured if some operators will access + media. .. note:: @@ -648,11 +647,6 @@ the appropriate values for your deployment. # Configure where plugins source lives export FIFTYONE_PLUGINS_DIR=... # eg /mnt/nfs/shared/plugins - # Configure where media and models will be downloaded - export FIFTYONE_MEDIA_CACHE_DIR=... - export FIFTYONE_MEDIA_CACHE_SIZE_BYTES=... - export FIFTYONE_MODEL_ZOO_DIR=... - # # Copy the values below from your Teams deployment # @@ -661,13 +655,11 @@ the appropriate values for your deployment. export FIFTYONE_ENCRYPTION_KEY=... export FIFTYONE_INTERNAL_SERVICE=1 - # If your deployment uses API connections - export FIFTYONE_API_KEY=... - export FIFTYONE_API_URL=... - - # If your deployment uses direct mongo connections + # Direct mongo connection for database operations export FIFTYONE_DATABASE_NAME=... export FIFTYONE_DATABASE_URI=... + + # Admin API connection for resolving secrets and permissions export FIFTYONE_API_KEY=... export API_URL=...