diff --git a/docs/concepts/authentication_permissions.rst b/docs/concepts/authentication_permissions.rst index 1e52773..1de7f8b 100644 --- a/docs/concepts/authentication_permissions.rst +++ b/docs/concepts/authentication_permissions.rst @@ -20,7 +20,8 @@ You can find more information about these roles in the We do not use any of the provided roles, instead we have created custom roles for our specific uses cases: -- **Admin**: Full access to all Superset data, dashboards, and reports. +- **Alpha**: Superusers of the LMS, have full access to Superset. +- **Admin**: Staff users of the LMS, have full access to Superset. - **Operator**: Access to the operator dashboard and data about the state of the installation. - **Instructor**: Access to the instructor dashboard and course specific data. @@ -51,8 +52,7 @@ an instructor should only be able to see data for the courses they are teaching. The following RLSF are implemented by default: -- **can_view_courses**: Return courses a user has access to. +- **can_view_courses**: Limits courses in the report to ones the user has access to. RLSF can be extended and assigned using a combination of extensions described in :ref:`extensions` docs. - diff --git a/docs/concepts/clickhouse.rst b/docs/concepts/clickhouse.rst index 48bb7fd..2ee8e5a 100644 --- a/docs/concepts/clickhouse.rst +++ b/docs/concepts/clickhouse.rst @@ -5,64 +5,9 @@ ClickHouse is a high-performance, column-oriented SQL database management system for online analytical processing (OLAP). It is used as the backend storage for the Aspects project that powers Superset. -Connect to Clickhouse Cloud -*************************** +Aspects is compatible with Clickhouse Cloud and on premise Clickhouse instances. -Aspects can be connected with Clickhouse Cloud following the steps below: - - -1. Disable the Clickhouse service: - -.. code-block:: yaml - - RUN_CLICKHOUSE: false - -2. Create a Clickhouse Cloud account and a cluster, and get the credentials. - -3. Once you get the credentials, set the following variables in your **config.yaml** file: - -.. code-block:: yaml - - CLICKHOUSE_HOST: - CLICKHOUSE_SECURE_CONNECTION: true - CLICKHOUSE_ADMIN_USER: - CLICKHOUSE_ADMIN_PASSWORD: - -4. Apply the changes by running the following command: - -.. code-block:: bash - - tutor config save - -5. Restart your local or production environment. After this change, you need to run the initialization - tasks. To do so, run the following command according to your environment: - -.. code-block:: bash - - tutor [local|dev|k8s] do init -l aspects - -Connect to on Premise Clickhouse -******************************** - -Aspects provide several configuration parameters that can be customized to connect to an on premise -Clickhouse instance. To do so, set the following variables in your **config.yaml** file: - -.. code-block:: yaml - - CLICKHOUSE_HOST: - CLICKHOUSE_SECURE_CONNECTION: true|false - CLICKHOUSE_ADMIN_USER: - CLICKHOUSE_ADMIN_PASSWORD: - CLICKHOUSE_CLIENT_PORT: # default to 9000 | 9440 used by initialization tasks - CLICKHOUSE_PORT: # default to 8123 | 8443 used by other services such as ralph and the lms - -Additionally, there are some other variables that are calculated based on the above variables, but -can be customized if needed: - -.. code-block:: yaml - - CLICKHOUSE_REPORT_SQLALCHEMY_URI: # used by superset to perform queries - CLICKHOUSE_ADMIN_SQLALCHEMY_URI: # used by initialization tasks to create tables and views +See :ref:`remote-clickhouse` for more information. Clickhouse Migrations **************************** diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst index c282cbc..8118d51 100644 --- a/docs/how-tos/index.rst +++ b/docs/how-tos/index.rst @@ -12,4 +12,5 @@ How-Tos Superset extra jinja filters Superset custom roles Clickhouse extra SQL - Extending DBT \ No newline at end of file + Connect to external Clickhouse database + Extending DBT diff --git a/docs/how-tos/remote_clickhouse.rst b/docs/how-tos/remote_clickhouse.rst new file mode 100644 index 0000000..1b31446 --- /dev/null +++ b/docs/how-tos/remote_clickhouse.rst @@ -0,0 +1,63 @@ +.. _remote-clickhouse: + +Connect to external Clickhouse database +*************************************** + +Connect to Clickhouse Cloud +########################### + +Aspects can be connected with Clickhouse Cloud following the steps below: + + +1. Disable the Clickhouse service: + +.. code-block:: yaml + + RUN_CLICKHOUSE: false + +2. Create a Clickhouse Cloud account and a cluster, and get the credentials. + +3. Once you get the credentials, set the following variables in your **config.yaml** file: + +.. code-block:: yaml + + CLICKHOUSE_HOST: + CLICKHOUSE_SECURE_CONNECTION: true + CLICKHOUSE_ADMIN_USER: + CLICKHOUSE_ADMIN_PASSWORD: + +4. Apply the changes by running the following command: + +.. code-block:: bash + + tutor config save + +5. Restart your local or production environment. After this change, you need to run the initialization + tasks. To do so, run the following command according to your environment: + +.. code-block:: bash + + tutor [local|dev|k8s] do init -l aspects + +Connect to on Premise Clickhouse +################################ + +Aspects provide several configuration parameters that can be customized to connect to an on premise +Clickhouse instance. To do so, set the following variables in your **config.yaml** file: + +.. code-block:: yaml + + CLICKHOUSE_HOST: + CLICKHOUSE_SECURE_CONNECTION: true|false + CLICKHOUSE_ADMIN_USER: + CLICKHOUSE_ADMIN_PASSWORD: + CLICKHOUSE_CLIENT_PORT: # default to 9000 | 9440 used by initialization tasks + CLICKHOUSE_PORT: # default to 8123 | 8443 used by other services such as ralph and the lms + +Additionally, there are some other variables that are calculated based on the above variables, but +can be customized if needed: + +.. code-block:: yaml + + CLICKHOUSE_REPORT_SQLALCHEMY_URI: # used by superset to perform queries + CLICKHOUSE_ADMIN_SQLALCHEMY_URI: # used by initialization tasks to create tables and views