Skip to content

DOC-871 fix broken links #1517

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

Merged
merged 1 commit into from
Aug 31, 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
2 changes: 1 addition & 1 deletion content/platforms/kubernetes/concepts/node-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Here are the ways that you can control the pod scheduling:

## Using node selectors

The [`nodeSelector`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/docs/operator.md#redisenterpriseclusterspec)
The [`nodeSelector`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/crds/v1/rec_crd.yaml)
property of the cluster specification uses the same values and structures as
the [Kubernetes `nodeSelector`](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector).
In general, node labels are a simple way to make sure that specific nodes are used for Redis Enterprise pods.
Expand Down
6 changes: 3 additions & 3 deletions content/platforms/kubernetes/concepts/sizing-on-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ aliases: /rs/administering/kubernetes/sizing-scaling-redis-enterprise-cluster-ku
/platforms/kubernetes/sizing-kubernetes/
---
The following article reviews the mechanism and methods available for sizing
and scaling a Redis Enterprise Cluster deployment.
and scaling a Redis Enterprise cluster deployment.

For minimum and recommended sizing, always follow the sizing guidelines
detailed in the [Redis Enterprise Hardware Requirements]({{< relref
detailed in the [Redis Enterprise hardware requirements]({{< relref
"/rs/administering/designing-production/hardware-requirements.md" >}}).

## Sizing and scaling cluster nodes
Expand All @@ -26,7 +26,7 @@ Define the number of cluster nodes in redis-enterprise-cluster.yaml file.
nodes: 3

The number of nodes in the cluster must be an uneven number
equal to or greater than 3. Refer to the article [Highly-Available Redis](https://redislabs.com/redis-enterprise/technology/highly-available-redis/)
equal to or greater than 3. Refer to the article [Highly Available Redis](https://redislabs.com/redis-enterprise/technology/highly-available-redis/)
for a detailed explanation on this topic.

Set the number of cluster nodes during deployment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,11 @@ the operator. The generated password is stored in a Kubernetes secret.
Where `rec-0` is replaced with of the pods associated with your Redis Entperise cluster.

{{< note >}}
- rec-0 is one of your cluster pods. Consider running the port-forward command in the background.
- The Openshift UI provides tools for creating additional routing options, including external routes. These are covered in [RedHat Openshift documentation](https://docs.openshift.com/container-platform/4.3/dev_guide/routes.html).
- `rec-0` is one of your cluster pods. Consider running the port-forward command in the background.
- The Openshift UI provides tools for creating additional routing options, including external routes.
{{< /note >}}

1. In a browser, go to localhost:8443 to open the Redis Enterprise admin console:
1. In a browser, go to `localhost:8443` to open the Redis Enterprise admin console:

![getting-started-kubernetes-openshift-image5]( /images/rs/getting-started-kubernetes-openshift-image5.png )

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To [create a database on an OpenShift 3.x cluster via the CLI]({{< relref "opens

1. An [OpenShift 3.x cluster installed](https://docs.openshift.com/container-platform/3.11/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/rs/administering/designing-production/hardware-requirements.md" >}})
1. The [kubectl package installed](https://kubernetes.io/docs/tasks/tools/install-kubectl/) at version 1.9 or higher
1. The [OpenShift cli installed](https://docs.openshift.com/online/starter/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands)
1. The [OpenShift cli installed](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html)

## For OpenShift 4.x via the OperatorHub

Expand All @@ -43,4 +43,4 @@ To [create a database on an OpenShift 4.x cluster via the CLI]({{< relref "opens

1. An [OpenShift 4.x cluster installed](https://docs.openshift.com/container-platform/4.3/welcome/index.html) with at least three nodes that each meet the [minimum requirements for a development installation]({{< relref "/rs/administering/designing-production/hardware-requirements.md" >}}).
1. The [kubectl package installed](https://kubernetes.io/docs/tasks/tools/install-kubectl/) at version 1.9 or higher
1. The [OpenShift cli installed](https://docs.openshift.com/online/starter/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands)
1. The [OpenShift cli installed](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This quick start guide is for generic Kubernetes distributions ([kOps](https://k
* [Azure Kubernetes Service](https://azure.microsoft.com/en-us/services/kubernetes-service/) (AKS)
* [Rancher](https://rancher.com/products/rancher/) / [Rancher Kubernetes Engine](https://rancher.com/products/rke/) (RKE)
* [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine) (GKE)
* [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/)(EKS)
* [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/) (EKS)

If you're running either OpenShift or VMWare Tanzu, we provide specific getting started guides for installing the Redis Enterprise Operator on these platforms:

Expand Down
28 changes: 14 additions & 14 deletions content/platforms/kubernetes/getting-started/tanzu/_index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
Title: Getting Started with VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS)
description: This section provides the steps required to set up a Redis Enterprise Cluster with the Kubernetes Operator on VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS).
description: This section provides the steps required to set up a Redis Enterprise cluster with the Kubernetes Operator on VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS).
weight: 60
alwaysopen: false
categories: ["Platforms"]
aliases: /rs/getting-started/getting-started-kubernetes/k8s-pks/
---
These are the steps required to set up a Redis Enterprise Cluster with the Kubernetes Operator on VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS).
These are the steps required to set up a Redis Enterprise cluster with the Kubernetes Operator on VMWare Tanzu Kubernetes Grid Integrated Edition (formerly Pivotal PKS).

Prerequisites:

Expand Down Expand Up @@ -67,8 +67,8 @@ Prerequisites:

{{< note >}}
While you can use the Kubernetes default namespace, it is a best practice to use a separate namespace if you are sharing the cluster with others.
The Operator deployment deploys and runs one Redis Enterprise Cluster in one Kubernetes namespace.
In order to run multiple Redis Enterprise Clusters, deploy each one in its own namespace.
The operator deployment deploys and runs one Redis Enterprise cluster in one Kubernetes namespace.
In order to run multiple Redis Enterprise clusters, deploy each one in its own namespace.
{{< /note >}}

1. Create a namespace for your deployment:
Expand Down Expand Up @@ -145,10 +145,10 @@ In order to run multiple Redis Enterprise Clusters, deploy each one in its own n

1. Edit the yaml files for your specific deployment, if necessary:

- [bundle.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/bundle.yaml) - The bundle file includes several declarations:
- `rbac` (Role-Based Access Control) defines who can access specified resources. The Operator application requires these definitions to deploy and manage the entire Redis Enterprise deployment (all cluster resources within a namespace). These include declaration of rules, role and rolebinding.
- `crd` creates a [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) for your Redis Enterprise Cluster resource. This provides another API resource to be handled by the k8s API server and managed by the operator we will deploy next.
- `operator` creates the operator deployment that is responsible for managing the k8s deployment and lifecycle of a Redis Enterprise Cluster. Among many other responsibilities, it creates a [stateful set](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) that runs the Redis Enterprise nodes, as pods. The yaml contains the latest image tag representing the latest Operator version available.
- [bundle.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/bundle.yaml) - The bundle file includes several declarations:
- `rbac` (Role-Based Access Control) defines who can access specified resources. The Operator application requires these definitions to deploy and manage the entire Redis Enterprise deployment (all cluster resources within a namespace). These include declaration of rules, role and role binding.
- `crd` creates a [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) for your Redis Enterprise cluster resource. This provides another API resource to be handled by the k8s API server and managed by the operator we will deploy next.
- `operator` creates the operator deployment that is responsible for managing the k8s deployment and lifecycle of a Redis Enterprise cluster. Among many other responsibilities, it creates a [stateful set](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) that runs the Redis Enterprise nodes, as pods. The yaml contains the latest image tag representing the latest Operator version available.

This yaml file is commonly not necessary to edit.

Expand Down Expand Up @@ -181,7 +181,7 @@ In order to run multiple Redis Enterprise Clusters, deploy each one in its own n
redis-enterprise-operator 1/1 1 1 0m36s
```

1. Create a storage class. The Redis Enterprise Cluster deployment dynamically provisions Persistent Volume Claims (PVCs) for use with cluster persistent storage needs. In order to create dynamic PVCs, the Kubernetes cluster must have a storage class defined. Determine whether a storage class is defined on your PKS cluster:
1. Create a storage class. The Redis Enterprise cluster deployment dynamically provisions Persistent Volume Claims (PVCs) for use with cluster persistent storage needs. In order to create dynamic PVCs, the Kubernetes cluster must have a storage class defined. Determine whether a storage class is defined on your PKS cluster:

```sh
kubectl get storageclasses
Expand Down Expand Up @@ -240,9 +240,9 @@ You can omit the reclaimPolicy declaration in the yaml file, in case of error, f
For production environments you must retain the Persistent Volume Claims (PVCs) when cluster persistent is used, in order to enable recovery.
{{< /note >}}

You will use the storage class name you have just created in the next step, editing the Redis Enterprise Cluster (REC) yaml.
You will use the storage class name you have just created in the next step, editing the Redis Enterprise cluster (REC) yaml.

- [app_v1_redisenterprisecluster_cr.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/5.4.10-8/crds/app_v1_redisenterprisecluster_cr.yaml) - Defines the configuration of the newly created resource: Redis Enterprise Cluster.
- [rec_crd.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/crds/v1/rec_crd.yaml) - Defines the configuration of the newly created resource: Redis Enterprise cluster.
This yaml could be renamed your_pks_cluster.yaml to keep things tidy, but this isn’t a mandatory step. This yaml **must** be edited, however, to reflect the specific configurations of your cluster. Here are the only fields you **must** review before you apply the REC yaml:

- `name` - “your_cluster_name” (e.g. “re-cluster”). You can keep the default name or choose your own
Expand All @@ -256,7 +256,7 @@ For production environments you must retain the Persistent Volume Claims (PVCs)

<!--- - persistentSpec: enabled: \<false/true\>
Check your Redis Software nodes’ enabled/disabled flag for [persistency](https://redislabs.com/redis-features/persistence). The default is “false.”
we now default to using persistence-->
we now default to using persistence -->

- `storageClassName` - Your storage class name from the previous step.
- `redisEnterpriseNodeResources` - The [compute resources](https://docs.openshift.com/enterprise/3.2/dev_guide/compute_resources.html#dev-compute-resources) required for each node. You can use the default or set your own. If your cluster is resource constrained, the minimum workable limits for basic testing are 2 CPU and 3GB. For development and production, see the [minimum hardware requirements]({{< relref "/rs/administering/designing-production/hardware-requirements.md" >}}).
Expand Down Expand Up @@ -295,7 +295,7 @@ For production environments you must retain the Persistent Volume Claims (PVCs)

## Step 3: Create your cluster

1. Once you have `your_pks_cluster.yaml` file set, you need to apply it to create your Redis Enterprise Cluster:
1. Once you have `your_pks_cluster.yaml` file set, you need to apply it to create your Redis Enterprise cluster:

```sh
$ kubectl apply -f your_cluster_name.yaml
Expand Down Expand Up @@ -512,7 +512,7 @@ In order to create your database, you will log in to the Redis Enterprise UI.

## Step 5: Cleaning up

To remove the Redis Enterprise Cluster from your PKS deployment:
To remove the Redis Enterprise cluster from your PKS deployment:

1. [Delete]({{< relref "/rs/administering/database-operations/deleting-database.md" >}}) any databases you created.

Expand Down
4 changes: 2 additions & 2 deletions content/platforms/kubernetes/reference/cluster-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ You can create this binding manually, but we do not recommend it.
- [`nodes`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md#redisenterpriseclusterspec): `nnn`

This [must be an odd number](https://redislabs.com/redis-enterprise/technology/highly-available-redis/) that is 3 or higher.
- [`uiServiceType`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/docs/operator.md#redisenterpriseclusterspec): `service_type`
- [`uiServiceType`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md#redisenterpriseclusterspec): `service_type`

This controls how the Redis Enterprise UI is exposed on the cluster.
The service_type must be either `ClusterIP` or `LoadBalancer` (default: `ClusterIP`).
This is an optional configuration based on [k8s service types](https://kubernetes.io/docs/tutorials/kubernetes-basics/expose/expose-intro/).

- [`persistentSpec`](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_cluster_api.md#redisenterpriseclusterspec):

You can add a `storageClassName` that specifies the [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) used for your nodes’ persistent disks. For example, AWS uses “gp2” as a default, GKE uses “standard” and Azure uses "default".
You can add a `storageClassName` that specifies the [Storage Class](https://kubernetes.io/docs/concepts/storage/storage-classes/) used for your nodes’ persistent disks. For example, AWS uses “gp2” as a default, GKE uses “standard” and Azure uses "default".

Also, adding a `volumeSize` lets you control the size of the persistent volume attached to the Redis Enterprise pods.

Expand Down
2 changes: 1 addition & 1 deletion content/platforms/kubernetes/tasks/replica-of-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ aliases:
---

You can configure a replica of a database by creating an item in
the `replicaSources` section of the [Redis Enterprise Database specification](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec). The value of
the `replicaSources` section of the [Redis Enterprise database specification](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/redis_enterprise_database_api.md#redisenterprisedatabasespec). The value of
`replicaSourceType` must be 'SECRET'; `replicaSourceName`
must be the name of a secret that contains the replica source url.

Expand Down