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

Update references to old plan names #1409

Merged
merged 4 commits into from
Jun 30, 2021
Merged
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
55 changes: 27 additions & 28 deletions content/modules/modules-quickstart.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,73 @@
---
title: Modules Quick Start
title: Modules quick start
linkTitle: Quick start
description:
weight: 1
alwaysopen: false
categories: ["Modules"]
---
To quickly get access to a Redis Enterprise database with a module,
you can sign up for a free Redis Cloud database and enable the module that you want to try out.
To quickly get access to a Redis database with a module,
you can sign up for a free Redis Enterprise Cloud subscription, create a database, and then enable the module that you want to try out.

You can also try out modules with [Redis Enterprise Software (RS)]({{< relref "/rs/getting-started/_index.md" >}}), RS in a [Docker container]({{< relref "/rs/getting-started/getting-started-docker.md" >}}), or any [other platform]({{< relref "/platforms/_index.md" >}}) that Redis Enterprise is offered on,
but a free Redis Cloud database is easy, free, and without the hassle of managing infrastructure.
You can also try out modules with [Redis Enterprise Software]({{< relref "/rs/getting-started/_index.md" >}}), REdis Enterprise Software in a [Docker container]({{< relref "/rs/getting-started/getting-started-docker.md" >}}), or any [other platform]({{< relref "/platforms/_index.md" >}}) that Redis Enterprise Software is offered on.

The modules that are currently available for Redis Cloud are:
Free Redis Enterprise Cloud subscriptions are easy and avoid the hassle of managing infrastructure.

The modules that are currently available for Redis Enterprise Cloud are:

- [RediSearch]({{< relref "/modules/redisearch/_index.md" >}})
- [RedisGraph]({{< relref "/modules/redisgraph/_index.md" >}})
- [RedisBloom]({{< relref "/modules/redisbloom/_index.md" >}})
- [RedisJSON]({{< relref "/modules/redisjson/_index.md" >}})
- [RedisTimeSeries]({{< relref "/modules/redistimeseries/_index.md" >}})

The steps for getting up and running with a database that has a module enabled are:
To get up and running with a Redis database and your preferred module:

1. Create a new subscription.
1. Create a new database with the module enabled.
1. Connect to the database.

The following steps provide a high-level walkthrough. For more details, see the Redis Enterprise Cloud [quick start]({{< relref "/rc/rc-quickstart.md" >}})

## Step 1: Create a new subscription

To create a new subscription:

1. Go to [Redis Cloud](http://app.redislabs.com) and follow the instructions for creating a free Redis Cloud account.
After you create your account, click **New Subscription**.
1. Go to [Redis Enterprise Cloud](http://app.redislabs.com) and follow the instructions to create a free subscription.

If you have a login for Redis Cloud:
After signing in to the Redis Cloud admin console, select **New Subscription**.

1. Log in to Redis Cloud.
1. In the Redis Cloud menu, click **Subscriptions**.
1. At the bottom of the page, click ![Add](/images/rs/icon_add.png#no-click "Add").
1. Select your subscription configuration:
1. For the cloud provider, make sure that **Amazon AWS** is selected.

1. For the cloud provider, select **Amazon Web Services** (AWS), **Google Cloud Platform** (GCP), or **Microsoft Azure**.
<!-- , **Microsoft Azure**, **Google Cloud Platform** -->
1. Select the region to create the subscription in.
1. In the Redis Cloud service levels, select the Redis Cloud Essentials **30MB/1 Database** level.
1. Select a region to deploy the subscription to.
1. In the **Fixed size** panel, select the Free tier (30MB dataset size).
1. Enter a name for the subscription.
1. Click **Create**.

![new-free-cloud-subscription](/images/rc/new-free-cloud-subscription.png)

The subscription shows a "Pending" status and takes a few minutes to provision.
You receive an email when your subscription is ready to use.
This takes you to the **Create Database** screen.

## Step 2: Create a database with a module enabled

After you create a subscription, you can create a database:

1. Enter a name for the database.
1. Enable the modules and select the module you want to use.
1. Click **Activate**.
1. In **Database name**, enter a name for your database.

1. Uee the **Modules** drop-down list to select your module.

![new-cloud-database-modules](/images/rc/new-cloud-database-modules.png)
1. Select **Activate**.

The database is in "Pending" status.
When the database is created, you can see the database settings, including:

- Endpoint - The address you use to connect to the database
- Redis Password - The password you must use in your application connections to authenticate with the database
When the database is created, you view the database settings, including:

- Endpoint: The address you use to connect to the database
- Redis Password: The password you must use in your application connections to authenticate with the database

## Step 3: Connect to your database

Now you can connect to the database with telnet, redis-cli, an application or [RedisInsight](https://redislabs.com/redisinsight/).
Now you can connect to the database with redis-cli, an application, or [RedisInsight](https://redislabs.com/redisinsight/).

To get started with the modules, go to the quick start guide for the module that you enabled:

Expand Down
22 changes: 14 additions & 8 deletions content/rc/api/examples/audit-system-logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
Title: Auditing using System Log
Title: Audit using Service Log
description: Using the Redis Labs system log to track and audit actions performed in the account
weight: 60
alwaysopen: false
Expand All @@ -10,15 +10,15 @@ aliases: /rv/api/how-to/view-auditing-using-system-log/
/rc/examples/audit-system-logs/
/rc/api/examples/audit-system-logs.md
---
System logs collect and report actions performed on various entities in your Redis Enterprise Cloud subscription. These entities include the account itself, users, API Keys, subscriptions, databases, accounts, payment methods and more. For each entity, various lifecycle events are logged in the system log.
Service logs collect and report actions performed on various entities in your Redis Enterprise Cloud subscription. These entities include the account itself, users, API Keys, subscriptions, databases, accounts, payment methods and more. For each entity, various lifecycle events are logged in the system log.

You can view the system log in the Redis Cloud admin console by selecting `Menu` and then `System Log`. This will display the system log entries for the current account.
You can view the system service log in the Redis Cloud admin console by selecting **Service log** from the console menu. This displays recent service log entries for the current account.

![System Logs in the UI](/images/rc/system_log.png)
![Service service logs in the admin console](/images/rc/system_log.png)

### System logs API operation
### System service log API

The API operation for querying the system log is `GET /logs`.
The API operation for querying the system service log is `GET /logs`.

For example, the following request returns the latest 100 system log entries, in descending order:

Expand All @@ -32,20 +32,26 @@ The `/logs` API operation accepts the following parameters:
- `limit` - The maximum number of entries to return per request. Default value is `100`.

{{< note >}}
The system log returns information for the entire account. It reports log entries for all types of entities, including Redis Labs Essentials and Redis Labs Pro subscriptions, databases and related entities.
The system log returns information for the entire account. It reports log entries for all types of entities, including Redis Labs Free, Fixed, and Flexible subscriptions, databases, and related entities.
{{< /note >}}

### Request results

An API System Log request results in data that includes an `entries` array. The entries are sorted by system log entry ID in descending order. Each entry contains these properties:
An API system log request results in data that includes an `entries` array. The entries are sorted by system log entry ID in descending order and include the following properties:

- `id` - A unique identifier for each system log entry.

- `time` - The system log entry timestamp, defined in ISO-8601 date format and in the UTC timezone (for example: `2019-03-15T14:26:02Z`).

- `originator` - The name of the user who performed the action described by the system log entry.

- `apiKeyName` - The name of the API key used to perform the action described by the system log entry.
This field only appears if the action was performed through the API.
If the operation was performed through the Redis Cloud admin console this property is omitted.

- `resource` - The name of the entity associated with the logged action (for example, database name).
This property is omitted if it is not applicable to the specific log entry.

- `type` - The category associated with the action log entry.

- `description` - The detailed description of the action in the log entry.
2 changes: 1 addition & 1 deletion content/rc/api/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
Title: Get started with the REST API
linkTitle: Get started
description: Describes how Redis Cloud REST API uses keys to authenicate and authorize access.
description: Describes how Redis Cloud REST API uses keys to authenticate and authorize access.
weight: 10
alwaysopen: true
categories: ["RC"]
Expand Down
24 changes: 12 additions & 12 deletions content/rc/api/get-started/process-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ weight: 60
alwaysopen: false
categories: ["RC"]
aliases: /rv/api/concepts/provisioning-lifecycle/
/rv/api/concepts/provisioning-lifecycle.md
/rv/api/how-to/enable-your-account-to-use-api/
/rv/api/how-to/enable-your-account-to-use-api.md
/rc/api/how-to/enable-your-account-to-use-api/
/rc/api/how-to/enable-your-account-to-use-api.md
/rc/api/concepts/provisioning-lifecycle/
/rc/api/concepts/provisioning-lifecycle.md
/rc/api/get-started/process-lifecycle.md
/rc/api/get-started/process-lifecycle/
---
The Redis Enterprise Cloud REST API can operate on multiple resources, including multiple servers, services and related infrastructure.

These operations can create, update, and delete a variety of entites, including subscriptions, databases, cloud accounts, and more.

Many operations are not instantaneous; they take time to process and to deploy.
Flexible and Annual Redis Enterprise Cloud [subscriptions]({{< relref "/rc/subscriptions/" >}}) can leverage a RESTful API that permits operations against a variety of resources, including servers, services, and related infrastructure.

{{< note >}}
The Redis Cloud REST API is available only with Flexible or Annual subscriptions. It is not supported for Fixed or Free subscriptions.
The REST API is not supported for Fixed or Free subscriptions.
{{< /note >}}

These operations are broken into tasks that run asychronously; that is, they run in the background so that you can continue working with resources that aren't being modified.
[Once it's enabled]({{< relref "rc/api/get-started/enable-the-api.md" >}}), you can use the REST API to create, update, and delete sybscriptions, databases, and other entities.

When you make a request that kicks off a task, the response object provides a task identifier that you can use to track a task's progress through the asynchonous lifecycle.
API operations run asynchronously, which means that provisioning occurs in the background. When you submit a request, a background process starts working on it. The respose object includes an ID that lets you determine the status of the background process as it performs its work.

Not every REST API call is asynchronous. Operations that do not create or modify resources run sychronously. For example, most GET operations are sychronous.
For operations that do not create or modify resources (such as most GET operations), the API is sychronous; that is, the response object reports the results of the request.

Asynchronous operations have two main phases: processing and provisioning. A resource is not available until both phases are complete.

Expand All @@ -37,16 +38,15 @@ During this phase, the request is received, evaluated, planned and executed.

### Use tasks to track requests

When you request an asynchronous operation, including CREATE, UPDATE and DELETE operations, the response to the API REST request includes a `taskId`.
The `taskId` is a unique identifier that allows you to track the progress of the requested operation and get information on its state.
Many operations are asychronous, including CREATE, UPDATE, and DELETE operations. The response objects for such operations include a provide a `taskId` identifier that lets you track the progress of the underlying operation.

You can query the `taskId` to track the state of a specific task:

```shell
{{% embed-code "rv/api/20-get-task-id.sh" %}}
```

In this example, the `$TASK_ID` variable is set to hold the value of `taskId`. For example:
In this example, the `$TASK_ID` variable includes the `taskId` value.

```bash
TASK_ID=166d7f69-f35b-41ed-9128-7d753b642d63
Expand Down
Loading