Skip to content

Commit

Permalink
Merging master ahed of content updates.
Browse files Browse the repository at this point in the history
Merge branch 'master' into release-rs-6.2.4
  • Loading branch information
lanceleonard committed Aug 10, 2021
2 parents 78bf19a + 2a25dfe commit cd77534
Show file tree
Hide file tree
Showing 81 changed files with 1,002 additions and 697 deletions.
38 changes: 37 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,43 @@

The docs are updated regularly; here are some recent highlights:

## July 2021

- Redis Enterprise Software doc updates:

- Updated the [Redis client reference](https://docs.redislabs.com/latest/rs/references/client_references/) to improve readability and navigation. ([PR #1467](https://github.com/RedisLabs/redislabs-docs/pull/1467))

- Updated [release notes](https://docs.redislabs.com/latest/rs/release-notes/) to improve links to internal docs. ([PR #1443](https://github.com/RedisLabs/redislabs-docs/pull/1443))

- Continued to refine [install/setup](https://docs.redislabs.com/latest/rs/installing-upgrading/) docs, along with supporting material.
([PR #1460](https://github.com/RedisLabs/redislabs-docs/pull/1460))

- Clarified and improved readability of the [FAQs](https://docs.redislabs.com/latest/rs/faqs/). ([PR #1431](https://github.com/RedisLabs/redislabs-docs/pull/1431))

- Redis Enterprise Cloud doc updates:

- Continued reorganizing docs to improve navigation and discoverability. [Cloud account](https://docs.redislabs.com/latest/rc/cloud-accounts/) docs are now a top-level section and have been updated to improve accuracy and clarity. ([PR #1454](https://github.com/RedisLabs/redislabs-docs/pull/1454))

- Continued updating [preview docs](https://docs.redislabs.com/staging/release-rc-new-ui/rc/rc-quickstart/) to reflect the new admin console experience. ([PR #1453](https://github.com/RedisLabs/redislabs-docs/pull/1453))

- Clarified a number of docs based on feedback ([PR #1431](https://github.com/RedisLabs/redislabs-docs/pull/1431), [PR #1440](https://github.com/RedisLabs/redislabs-docs/pull/1440), [PR #1448](https://github.com/RedisLabs/redislabs-docs/pull/1448))

- Redis Enterprise for Kubernetes release notes

- Created a [support matrix](https://docs.redislabs.com/latest/platforms/kubernetes/reference/supported_k8s_distributions/) detailing the distributions (and versions) supported by Redis Enterprise for Kubernetes. ([PR #1451](https://github.com/RedisLabs/redislabs-docs/pull/1451))

- Created a [new article](https://docs.redislabs.com/latest/platforms/kubernetes/concepts/manage_rec_credentials/) describing how to manage Redis Enterprise cluster (REC) credentials. ([PR #1466](https://github.com/RedisLabs/redislabs-docs/pull/1466))

- Added [a warning](https://docs.redislabs.com/latest/platforms/kubernetes/concepts/persistent-volumes/) noting that the size of a persistent volume cannot be changed after deployment. ([PR #1449](https://github.com/RedisLabs/redislabs-docs/pull/1449))

- Clarified and improved readability of the [FAQs](https://docs.redislabs.com/latest/platforms/faqs/). ([PR #1459](https://github.com/RedisLabs/redislabs-docs/pull/1459))

- Redis module docs - Updated release notes for [all modules](https://docs.redislabs.com/latest/modules/) to be current, consistent, and easier to navigate. ([PR #1426](https://github.com/RedisLabs/redislabs-docs/pull/1426))

- Additional updates to fix typos, missing images, and other glitches

To learn more, review the [merged pull requests](https://github.com/RedisLabs/redislabs-docs/pulls?q=is%3Apr+merged%3A2021-07-01..2021-07-31)

## June 2021

- Redis Enterprise Software doc updates:
Expand Down Expand Up @@ -112,4 +149,3 @@ The docs are updated regularly; here are some recent highlights:

To learn more, review the [merged pull requests](https://github.com/RedisLabs/redislabs-docs/pulls?q=is%3Apr+merged%3A2021-01-01..2021-03-31)


14 changes: 0 additions & 14 deletions content/embeds/backup-locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,20 +71,6 @@ To backup to a local mount point for a node:

For example: `/mnt/Public`

### OpenStack Swift

{{< note >}}
Support for OpenStack Object Storage ("Swift") for backup, import and export location ends on November 30, 2020.
{{< /note >}}

Before you choose to backup to OpenStack Swift, make sure that you have:

- Storage URL in the format: `https://<openstack_url>/v1`
- Container
- Prefix (Optional)
- User
- Key

### Azure Blob Storage

Before you choose to backup to Azure Blob Storage, make sure that you have:
Expand Down
52 changes: 24 additions & 28 deletions content/embeds/cluster-dns-embed.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,47 @@
DNS is critical to the default operation of Redis Enterprise Software (RS) deployments.
DNS is critical to the default operation of Redis Enterprise Software deployments.
This can be altered, but instead using the [Discovery Service]({{< relref "/rs/concepts/data-access/discovery-service.md" >}}),
which utilizes pure IP-based connectivity as it is compliant with the Redis Sentinel API.

As part of the high availability capabilities in RS,
As part of the high availability capabilities in Redis Enterprise Software,
each node includes a small DNS server for managing various internal cluster functionalities,
such as automatic failover or automatic migration.
Therefore, the node on which you are provisioning RS should not run any other DNS server except for the one included with the RS installation.
The existence of another DNS server on the same machine can cause unexpected behavior in RS.
Therefore, nodes that provision Redis Enterprise Software should run only the DNS server included with the software. They should not run any other DNS servers; otherwise, unexpected behavior can occur.

## Cluster name (FQDN) and connection management

When connecting to the cluster for administration or connecting to databases for data access, there are 2 options:
Whether you're administering Redis Enterprise Software or accessing databases, there are two ways to connect:

- URL-based Connections - URL-based connections require DNS setup for resolution of the cluster name (FQDN) when connecting to the cluster
for administration or connecting to databases for data access.
As the topology of the cluster changes and new nodes are added or existing nodes are removed from the cluster,
DNS records may need to be modified.
However, with URL-based connections, applications simply have to remember the URL for the cluster or the database.
- IP-based Connections - IP-based connections do not require DNS setup and instead use IP addresses of the nodes in the cluster
for connecting to the cluster for administration or data access.
As the topology of the cluster changes and new nodes are added or existing nodes are removed from the cluster,
no DNS records need to be modified.
However, administrators and applications connecting to the cluster and to the databases need to maintain the IP address
of at least one node in the cluster to discover and access the cluster topology.
- URL-based connections - URL-based connections use DNS to resolve the fully qualified cluster domain name. This means that DNS records might need to be updated when topology changes, such as adding (or removing) nodes from the cluster.

Because apps and other clients connections rely on the URL, they do not need to be modified when topology changes.

- IP-based connections - IP-based connections do not require DNS setup, as they rely on the underlying TCP/IP addresses. As long as topology changes do not change the address of the cluster nodes, no configuration changes are needed, DNS or otherwise.

However, changes to IP addresses (or changes to IP address access) impact all apps and clients connecting to the node.

## URL-based connections and how to set up cluster name (FQDN)

The Fully Qualified Domain Name (FQDN) is the unique cluster identifier that enables clients to connect to [the different components]({{< relref "/rs/concepts/_index.md" >}})
that are part of the Redis Enterprise Software.
The FQDN is a crucial component of the high-availability mechanism in RS because it is used by the internal DNS
to enable the automatic and transparent failover of nodes, databases shards, and endpoints, by automatically updating their IP addresses.
The Fully Qualified Domain Name (FQDN) is the unique cluster identifier that enables clients to connect to [the different components]({{< relref "/rs/concepts/_index.md" >}}) of Redis Enterprise Software.
The FQDN is a crucial component of the high-availability mechanism because it's used internally to enable and implement automatic and transparent failover of nodes, databases shards, and endpoints.

{{< note >}}
Setting the cluster's FQDN is a one-time operation.
After the FQDN is set it cannot be updated.
Setting the cluster's FQDN is a one-time operation; it cannot be changed after being set.
{{< /note >}}

The FQDN must always comply with the IETF's [RFC 952](http://tools.ietf.org/html/rfc952) standard
and section 2.1 of the [RFC 1123](http://tools.ietf.org/html/rfc1123) standard.

## Naming the cluster FQDN
## Name the cluster domain name

You have two options for naming the cluster FQDN:
You can name the cluster domain name using either DNS or IP addresses.

### DNS

Use this option if you already have your own domain, would like to make the cluster part of your domain and are able to update the DNS.
Use DNS if you:

- have your own domain
- want to integrate the cluster into that domain
- can access and update the DNS records for that domain

1. Make sure that the cluster and at least one node (preferably all nodes) in the cluster
are correctly configured in the DNS with the appropriate NS entries.
Expand Down Expand Up @@ -103,10 +99,10 @@ Once you have the IP address, you can simply connect to port number 8443 (for ex
However, as the topology of the cluster changes and node with the given IP address is removed,
you need to remember the IP address of another node participating in this cluster to connect to the admin console and manage the cluster.

Applications connecting to RS databases for data access have the same constraints.
Applications connecting to Redis Software databases have the same constraints.
When using the IP-based connection method, you can use the [Discovery Service]({{< relref "/rs/concepts/data-access/discovery-service.md" >}})
to discover the database endpoint for a given database name as long as you have an IP address for at least one of the nodes in the cluster.
The API used for discovery service is compliant with the Redis Sentinel API.

You can find a simple example of URL and IP-based connection in the "Testing Connectivity to your Database" section
of [Creating a new database]({{< relref "/rs/administering/creating-database/_index.md#simple-connectivity-test" >}}).
To test your connection, try pinging the service. For help, see [Connect yo your database]connYou can find a simple example of URL and IP-based connection in the "Testing Connectivity to your Database" section
of [Creating a new database]({{< relref "rs/getting-started/#step-4-connect-to-your-database" >}}).
6 changes: 3 additions & 3 deletions content/glossary/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Provides applications read-only access to replicas of the data set from differen
Log files that keep a record of data changes by writing to the end of a file. This happens with every write, or every second to allow data recovering the entire
dataset by replaying the append-only log from the beginning to the end.

More info: [Data Persistence]({{<relref "content/rc/concepts/data-persistence.md" >}}), [Data Persistence with Redis Enterprise Software]({{<relref "content/rs/concepts/data-access/persistence.md" >}})
More info: [Data Persistence]({{<relref "content/rc/databases/configuration/data-persistence.md" >}}), [Data Persistence with Redis Enterprise Software]({{<relref "content/rs/concepts/data-access/persistence.md" >}})
{{%/definition%}}

{{%definition "CIDR allowlist"%}}
Expand All @@ -54,7 +54,7 @@ More info: [CIDR wikipedia](https://en.wikipedia.org/wiki/Classless_Inter-Domain
{{%definition "cluster"%}}
A Redis Enterprise cluster is composed of identical nodes that are deployed within a data center or stretched across local availability zones.

More info: [Database Clustering]({{<relref "content/rc/concepts/clustering.md" >}})
More info: [Database Clustering]({{<relref "content/rc/databases/configuration/clustering.md" >}})
{{%/definition%}}

{{%definition "Cluster Configuration Store (CSS)"%}}
Expand All @@ -80,7 +80,7 @@ More info: [CustomResourceDefinition](https://kubernetes.io/docs/reference/gloss
{{%definition "data eviction policy"%}}
Defines how excess data is handled when the database exceeds the memory limit.

More info: [Data Eviction Policy]({{<relref "/rc/concepts/data-eviction-policies.md">}})
More info: [Data Eviction Policy]({{<relref "/rc/databases/configuration/data-eviction-policies.md">}})
{{%/definition%}}

{{%definition "Domain Name Service (DNS)"%}}
Expand Down
2 changes: 1 addition & 1 deletion content/modules/add-module-to-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To add a module package to the cluster using the admin console:
## Upgrading the module for the database
After you add and updated module to the cluster, go to the configuration of the databases that use the module.
After you add an updated module to the cluster, go to the configuration of the databases that use the module.
The database configuration shows that a new version of the module is available for the database.
![update_available-1](/images/rs/update_available.png?width=1346&height=1600)
Expand Down
4 changes: 3 additions & 1 deletion content/modules/add-module-to-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ aliases:
Modules add additional functionality to your databases for specific use cases.
You can add modules to the database when you create the database.

## Add modules to a database
## Create a database with a module

{{< note >}}
- Before you add a module to a database,
we recommend that you [upgrade the module]({{< relref "/modules/add-module-to-cluster.md" >}}) to the latest version.
- Modules can be add to database only when creating a new database.
You can't add a module to an existing database.
- After you add a module to the database,
certain database fields for the database are disabled according to the supported capabilities of the module.
{{< /note >}}
Expand Down
Loading

0 comments on commit cd77534

Please sign in to comment.