Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge 3.6.x into main #12726

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 63 additions & 15 deletions docs/docs/installation/rasa-pro/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,28 +34,44 @@

### Python Package Installation

The Rasa Pro python package is named `rasa-plus`. The `rasa-plus` python packages as well as the docker containers are hosted on our GCP artifact registry.
The Rasa Pro python package is named `rasa-plus`. The `rasa-plus` python packages as well as the Docker containers are hosted on our GCP Artifact Registry.
As a prerequisite, you will need:

- to [install](https://cloud.google.com/sdk/docs/install) and [initialize](https://cloud.google.com/sdk/docs/initializing) the Google Cloud CLI.
- to [install](https://cloud.google.com/sdk/docs/install) the Google Cloud CLI.
- to verify that the user or service account you are using has the required permissions to access the repository.

#### Authentication Set-Up
To authenticate you need use a service account key file provided by Rasa to authenticate with Google Cloud.

In order for the package manager of choice (e.g, `pip` or `poetry`) to have the necessary credentials to authenticate with the registry, follow the steps in the [Google documentation](https://cloud.google.com/artifact-registry/docs/python/authentication#keyring).
Authenticate with GCP using the service account key.

Where required, input the following parameters:
```sh
gcloud auth activate-service-account --key-file=service-account.json
```

Set up keyring to allow Pip to authenticate with GCP Artifact Registry by installing keyring and then the backend that supports GCP Artifact Registry

```sh
gcloud artifacts print-settings python \
--project=rasa-releases \
--repository=rasa-plus-py \
--location=europe-west3
pip install keyring
pip install keyrings.google-artifactregistry-auth

Check warning on line 56 in docs/docs/installation/rasa-pro/installation.mdx

View workflow job for this annotation

GitHub Actions / Typo CI

keyrings

"keyrings" is a typo. Did you mean "keyring"?
```

Verify that the backends have been installed correctly

```sh
keyring --list-backends
```

The results should include `ChainerBackend` and `GooglePythonAuth`.

Check warning on line 65 in docs/docs/installation/rasa-pro/installation.mdx

View workflow job for this annotation

GitHub Actions / Typo CI

ChainerBackend

"ChainerBackend" is a typo. Did you mean "ChainedBackend"?


#### Installing with `pip`

Enter the following settings to the `.pypirc` file:
Enter the following settings to the `.pypirc` file. This can be found:

Check warning on line 70 in docs/docs/installation/rasa-pro/installation.mdx

View workflow job for this annotation

GitHub Actions / Typo CI

pypirc

"pypirc" is a typo. Did you mean "piracy"?

- Linux and MacOS: `$HOME/.pypirc`

Check warning on line 72 in docs/docs/installation/rasa-pro/installation.mdx

View workflow job for this annotation

GitHub Actions / Typo CI

pypirc

"pypirc" is a typo. Did you mean "piracy"?
- Windows: `%USERPROFILE%\.pypirc`

Check warning on line 73 in docs/docs/installation/rasa-pro/installation.mdx

View workflow job for this annotation

GitHub Actions / Typo CI

pypirc

"pypirc" is a typo. Did you mean "piracy"?


```
[distutils]
Expand All @@ -67,7 +83,19 @@

```

Next, add these specific settings to the pip configuration file as instructed in the [GCP authentication documentation](https://cloud.google.com/artifact-registry/docs/python/authentication#keyring-setup):
Next, add these specific settings to the pip configuration file. The location for this depends on whether you want to update the per-user file or the file specific to a virtual environment that you are using.

For the file associated with your operating system user:

- Linux: `$HOME/.config/pip/pip.conf` or `$HOME/.pip/pip.conf`
- MacOS: `/Library/Application Support/pip/pip.conf` or `$HOME/.config/pip/pip.conf`
- Windows: `%APPDATA%\pip\pip.ini` or `%USERPROFILE%\pip\pip.ini`

For virtual environments:

- Linux and macOS: `$VIRTUAL_ENV/pip.conf`
- Windows: `%VIRTUAL_ENV%\pip.ini`


```
[global]
Expand All @@ -79,7 +107,7 @@

#### Installing with `poetry`

To install `rasa-plus` with `poetry`, you will need to associate the artifact registry URL with `rasa-plus` before installing it.
To install `rasa-plus` with `poetry`, you will need to associate the Artifact Registry URL with `rasa-plus` before installing it.
Note that you must upgrade poetry to the latest minor (`1.2.0`) in order for `poetry` to work with the GCP authentication set-up.
Proceed with the following steps:

Expand All @@ -100,20 +128,40 @@

### Docker Image Installation

The Rasa Pro docker image is named `rasa-plus`. The docker images are hosted on our GCP artifact registry.
The Rasa Pro Docker image is named `rasa-plus`. The Docker images are hosted on our GCP Artifact Registry.
As a prerequisite, you will need:

- to [install](https://cloud.google.com/sdk/docs/install) and [initialize](https://cloud.google.com/sdk/docs/initializing) the Google Cloud CLI.
- to [install](https://cloud.google.com/sdk/docs/install) the Google Cloud CLI.
- to verify that the user or service account you are using has the required permissions to access the repository.

To be able to pull the docker image you need use a key file provided by Rasa to authenticate with google cloud.
To authenticate you need use a service account key file provided by Rasa to authenticate with Google Cloud.

```bash
gcloud auth activate-service-account --key-file=${KEYFILE}
gcloud auth list
gcloud auth configure-docker europe-west3-docker.pkg.dev
docker pull europe-west3-docker.pkg.dev/rasa-releases/rasa-plus/rasa-plus
```

### Using An Intermediate Repository
If you are using your own intermediate repository to cache libraries or dependencies (such as Artifactory or Nexus Repository Manager), you may need to generate a set of static credentials that allow you to authenticate with GCP Artifact Registry.

As a prerequisite, you will need:

- to [install](https://cloud.google.com/sdk/docs/install) the Google Cloud CLI.
- to verify that the user or service account you are using has the required permissions to access the repository.

To generate your credentials, run:

```sh
gcloud artifacts print-settings python \
--project=rasa-releases \
--repository=rasa-plus-py \
--location=europe-west3 \
--json-key=service-account.json
```

Your credentials can be found in the output. The username will be `_json_key_base64` and the password will be a long, base64 encoded string.

### Runtime Configuration

Rasa Pro will look for your license in the env var `RASA_PRO_LICENSE`.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/installation/rasa-pro/rasa-pro-artifacts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import RasaProBanner from "@theme/RasaProBanner";

<RasaProBanner />

- **Rasa Pro**, a drop-in replacement for Rasa Open Source enterprise
- **Rasa Pro**, a drop-in replacement for Rasa Open Source
- **Rasa Pro Services**, flexible infrastructure and APIs on top of Rasa
Open Source. Rasa Pro Services should be deployed alongside, but separately
from your production assistant.
Expand Down