Skip to content

Commit

Permalink
Merge pull request #12371 from RasaHQ/ATO-1063-pro-install-docs
Browse files Browse the repository at this point in the history
Docs; ATO-1063 Rasa Pro install doc update
  • Loading branch information
m-vdb authored Jun 19, 2023
2 parents 2e1c968 + c4f23e0 commit b612c49
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 23 deletions.
1 change: 1 addition & 0 deletions changelog/12371.doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update wording in Rasa Pro installation page.
44 changes: 26 additions & 18 deletions docs/docs/installation/rasa-pro/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,29 @@ import RasaProBanner from "@theme/RasaProBanner";

<RasaProBanner />

In this section you will learn how to install **Rasa Plus**, a drop-in replacement enterprise-ready version of Rasa Open Source, on your development environment.
In this section you will learn how to install **Rasa Pro**, a drop-in replacement enterprise-ready version of Rasa Open Source, on your development environment.

To learn more about deployments, please visit the following sections:

- [Deploying Rasa Plus in production](../../deploy/deploy-rasa)
- [Deploying Rasa Pro in production](../../deploy/deploy-rasa)
- [Deploying Rasa Pro Services in production](../../deploy/deploy-rasa-pro-services)

To learn more about compatibility between different versions of Rasa Plus and Rasa Pro Services, please see
To learn more about compatibility between different versions of Rasa Pro and Rasa Pro Services, please see
[compatibility matrix](../../compatibility-matrix.mdx).

## Rasa Plus Setup
## Rasa Pro Setup

Rasa Plus requires access credentials to install and a license to use. The instructions below assume you have
Rasa Pro requires access credentials to install and a license to use. The instructions below assume you have
credentials and a license.

### Install for Development

Rasa Plus is a drop-in replacement and enterprise-ready version of Rasa Open Source.
Rasa Pro is a drop-in replacement and enterprise-ready version of Rasa Open Source.
Additional functionality is provided through plugins while allowing you to continue using the existing Rasa Open Source CLI commands and parameters as you used to.

Installing Rasa Plus instead of Rasa Open Source will not break any existing scripts, automation or functionality you have built around Rasa Open Source.
Installing Rasa Pro instead of Rasa Open Source will not break any existing scripts, automation or functionality you have built around Rasa Open Source.

### Python Package Installation

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.
Expand Down Expand Up @@ -97,21 +97,29 @@ secondary = true

3. Run `poetry install`.

#### Installing with Docker

To be able to pull the docker using `pull` you need to be authenticated first.
### Docker Image Installation

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 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.

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

### Run Rasa Plus locally
### Runtime Configuration

Rasa Plus will look for your license in the env var `RASA_PRO_LICENSE`.
Rasa Pro will look for your license in the env var `RASA_PRO_LICENSE`.
You can set this env var temporarily in your terminal, but it is recommended
to set it persistently so that you don't have to set it every time you run
Rasa Plus.
Rasa Pro.

Bash:

Expand Down Expand Up @@ -151,8 +159,8 @@ You can increase UDP packet size by running `sudo sysctl -w net.inet.udp.maxdgra

:::

Congratulations! You have now successfully installed Rasa Plus on your development environment.
Congratulations! You have now successfully installed Rasa Pro on your development environment.
To learn more about production deployments, visit:

- [Deploying Rasa Plus in production](../../deploy/deploy-rasa)
- [Deploying Rasa Pro in production](../../deploy/deploy-rasa)
- [Deploying Rasa Pro Services in production](../../deploy/deploy-rasa-pro-services)
8 changes: 3 additions & 5 deletions docs/docs/installation/rasa-pro/rasa-pro-artifacts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ import RasaProBanner from "@theme/RasaProBanner";

<RasaProBanner />

- **Rasa Plus**, a drop-in replacement for Rasa Open Source enterprise
deployments. Rasa Plus should be used to deploy your assistant
into production.
- **Rasa Pro**, a drop-in replacement for Rasa Open Source enterprise
- **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.

Rasa Pro includes the Rasa Plus Python package, which is a drop-in replacement for Rasa Open Source that includes all the functionality of Rasa Open Source as well as additional features.
Rasa Plus features are built on a plugin architecture that is seamlessly integrated with Rasa Open Source.
Rasa Pro features are built on a plugin architecture that is seamlessly integrated with Rasa Open Source.

For example, in the below diagram, tracing is run as a hook implementation in Rasa Plus, whose specification is defined and registered in Rasa Open Source.

Expand All @@ -29,4 +27,4 @@ For example, in the below diagram, tracing is run as a hook implementation in Ra
The hook configures the tracing backend as specified in the `endpoints.yml` and instruments model training and message handling actions.
The hook is then called within the Rasa Open Source main module, which is the entry point for the Rasa Open Source command line.

The plugin architecture enables Rasa Plus to continue enhancing the Rasa Open Source argument parser while maintaining the same runnable command name (`rasa`).
The plugin architecture enables Rasa Pro to continue enhancing the Rasa Open Source argument parser while maintaining the same runnable command name (`rasa`).

0 comments on commit b612c49

Please sign in to comment.