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

Change Platforms to Kubernetes Doc-913 #1562

Merged
merged 16 commits into from
Oct 6, 2021
2 changes: 1 addition & 1 deletion content/embeds/supported-platforms-embed.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Make sure your system meets these requirements:
| Oracle Linux 7 | Based on the corresponding RHEL version |
| Amazon Linux | Version 1 |
| Docker | [Docker images]({{< relref "/rs/getting-started/getting-started-docker.md" >}}) of Redis Enterprise Software are certified for Development and Testing only. |
| Kubernetes, Pivotal Platform (PCF) and other orchestration and cloud environments | See the [Platform documentation]({{< relref "/platforms" >}}) |
| Kubernetes | See the [Platform documentation]({{< relref "/kubernetes/_index.md" >}}) |

## VMware

Expand Down
21 changes: 21 additions & 0 deletions content/kubernetes/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
Title: Redis Enterprise Software on Kubernetes
linkTitle: Redis Enterprise on Kubernetes
description: The Redis Enterprise operators allows you to use Redis Enterprise Software on Kubernetes.
weight: 50
alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/,
/kubernetes/,
/k8s/,
/rs/getting-started/getting-started-kubernetes/,
/rs/administering/kubernetes/,
/kubernetes/_index.md,

]
---

Kubernetes provides enterprise orchestration of containers and has been widely adopted. The Redis Enterprise operator for Kubernetes provides a simple way to get a Redis Enterprise cluster on Kubernetes and enables more complex deployment scenarios.

{{< allchildren style="h2" description="true" />}}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ categories: ["Platforms"]
aliases: /rs/concepts/kubernetes/redis-labs-kubernetes-architecture-overview
/rs/concepts/kubernetes-architecture/
/platforms/kubernetes/kubernetes-architecture/
/kubernetes/architecture/
/kubernetes/architecture/_index.md/
---
Redis bases its Kubernetes architecture on several vital concepts.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@ description: This section provides a description of the design of the Redis Ente
weight: 30
alwaysopen: false
categories: ["Platforms"]
aliases: /rs/concepts/kubernetes/k8s-operator-based-deployments
/platforms/kubernetes/kubernetes-with-operator/
aliases: {
/rs/concepts/kubernetes/k8s-operator-based-deployments,
/platforms/kubernetes/kubernetes-with-operator/,
/platforms/kubernetes/architecture/operator/,
/platforms/kubernetes/architecture/operator.md,
/kubernetes/architecture/operator.md,
/kubernetes/architecture/operator/,
}
---
The Redis Enterprise operator is the fastest, most efficient way to
deploy and maintain a Redis Enterprise cluster in Kubernetes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ aliases: [
/platforms/kubernetes/getting-started/_index.md,
/platforms/kubernetes/deployment/,
/platforms/kubernetes/deployment/_index.md,
/kubernetes/deployment/_index.md,
/kubernetes/deployment/_index/

]
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ aliases: [
/platforms/kubernetes/concepts/managing-images.md,
/platforms/kubernetes/deployment/container-images/,
/platforms/kubernetes/deployment/container-images.md,
/kubernetes/deployment/container-images.md,
/kubernetes/deployment/container-images/,
]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/openshift/quick-start/,
/platforms/kubernetes/getting-started/openshift/,
/platforms/kubernetes/getting-started/openshift/_index.md,
/platforms/kubernetes/getting-started/openshift/quick-start/,
/platforms/kubernetes/getting-started/openshift/quick-start.md,
/rs/getting-started/getting-started-kubernetes/k8s-openshift/,
Expand All @@ -20,6 +22,9 @@ aliases: [
/platforms/kubernetes/getting-started/openshift/_index/,
/platforms/kubernetes/deployment/openshift/_index.md,
/platforms/kubernetes/deployment/openshift/_index.md,
/kubernetes/deployment/openshift/_index.md,
/kubernetes/deployment/openshift/_index/,

]
---
The deployment of Redis Enterprise clusters is managed with the Redis Enterprise operator that you deploy in the namespace for your project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ weight: 60
alwaysopen: false
categories: ["Platforms"]
draft: true
hidden: true
aliases: [
]
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@ aliases: [
/platforms/kubernetes/getting-started/openshift/openshift-cli/,
/platforms/kubernetes/getting-started/openshift/openshift-cli.md,
/platforms/kubernetes/deployment/openshift/openshift-cli/,
/platforms/kubernetes/deployment/openshift/openshift-cli/
/platforms/kubernetes/deployment/openshift/openshift-cli/,
/kubernetes/deployment/openshift/openshift-cli.md,
/kubernetes/deployment/openshift/openshift-cli/,

]
---
These are the steps required to set up a Redis Enterprise Software
Cluster with OpenShift.
cluster with OpenShift.

Prerequisites:

Expand Down Expand Up @@ -134,7 +136,7 @@ Changes to this file can cause unexpected results.
```

<!--
[rbac.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/rbac.yaml)
[rbac.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/rbac.yaml)

The rbac (Role-Based Access Control) yaml defines who can access which resources. We need this to allow our Operator application to deploy and manage the entire Redis Enterprise deployment (all cluster resources within a namespace). Therefore, we strongly recommend **not** changing anything in this yaml file. To apply it, type:

Expand All @@ -149,7 +151,7 @@ serviceaccount/redis-enterprise-operator created
rolebinding.rbac.authorization.k8s.io/redis-enterprise-operator created`
-->
<!---
- [sb_rbac.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/sb_rbac.yaml)
- [sb_rbac.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/sb_rbac.yaml)

If you deploy a service broker, also apply the sb_rbac.yaml file. The sb_rbac (Service Broker Role-Based Access Control) yaml defines the access permissions of the Redis Enterprise Service Broker.

Expand All @@ -171,7 +173,7 @@ Changes to this file can cause unexpected results.
```
--->
<!--
- [crd.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/crd.yaml)
- [crd.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/crd.yaml)

The next step applies crd.yaml, creating 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. We strongly recommend **not** changing anything in this yaml file.

Expand All @@ -185,11 +187,11 @@ You should receive the following response:

`customresourcedefinition.apiextensions.k8s.io/redisenterpriseclusters.app.redislabs.com configured`

- [operator.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/operator.yaml)
- [operator.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/operator.yaml)

Applying this yaml creates the operator deployment, which 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).

Always make sure you have the latest [operator.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/operator.yaml). Alternatively, you can edit the following tag:
Always make sure you have the latest [operator.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/operator.yaml). Alternatively, you can edit the following tag:
image:redislabs/operator:tag

To apply the operator.yaml, run:
Expand All @@ -206,7 +208,7 @@ Now, run `kubectl get deployment` and verify that your redis-enterprise-operator

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

- [redis-enterprise-cluster.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/redis-enterprise-cluster.yaml)
- [redis-enterprise-cluster.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/redis-enterprise-cluster.yaml)
-->

- The [rec_rhel.yaml](https://github.com/RedisLabs/redis-enterprise-k8s-docs/blob/master/openshift/rec_rhel.yaml) defines the configuration of the newly created resource: Redis Enterprise Cluster. You can rename the file to `your_cluster_name.yaml`, but it is not required.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ weight: 10
alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/openshift/getting-started-operatorhub/,
/platforms/kubernetes/getting-started/openshift/openshift-operatorhub.md
/platforms/openshift/getting-started-operatorhub/,
/platforms/kubernetes/getting-started/openshift/openshift-operatorhub/,
/platforms/kubernetes/getting-started/openshift/openshift-operatorhub.md,
/platforms/kubernetes/deployment/openshift/openshift-operatorhub/,
/platforms/kubernetes/deployment/openshift/openshift-operatorhub.md,
/kubernetes/deployment/openshift/openshift-operatorhub.md,
/kubernetes/deployment/openshift/openshift-operatorhub/

]
---
The OperatorHub is a feature of OpenShift 4.x that enables browsing a catalog
Expand Down Expand Up @@ -44,11 +48,11 @@ this constraint installed, the operator cannot create Redis Enterprise clusters.

The security context constraint for the operator needs to be **installed only once** and **must not be deleted**.

The constraint [scc.yaml](https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/scc.yaml)
The constraint [scc.yaml](https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/scc.yaml)
can be downloaded and installed by a cluster administrator with the commands:

```sh
curl -O https://raw.githubusercontent.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/scc.yaml
curl -O https://raw.githubuser.com/RedisLabs/redis-enterprise-k8s-docs/master/openshift/scc.yaml
oc apply -f scc.yaml
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ aliases: [
/platforms/kubernetes/getting-started/quick-start.md,
/platforms/kubernetes/deployment/quick-start/,
/platforms/kubernetes/deployment/quick-start.md,
/kubernetes/deployment/quick-start.md,
/kubernetes/deployment/quick-start/
]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ aliases: [
/platforms/kubernetes/getting-started/tanzu._index.md,
/platforms/kubernetes/deployment/tanzu/,
/platforms/kubernetes/deployment/tanzu/_index.md,
/kubernetes/deployment/tanzu/,
/kubernetes/deployment/tanzu/_index.md,

]
---
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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ description:
weight: 99
alwaysopen: false
categories: ["Platforms"]
aliases: /rs/getting-started/pcf/
/platforms/pcf/installing-pcf/
aliases: [ /rs/getting-started/pcf/,
/platforms/pcf/installing-pcf/,
/platforms/pcf/,
/platforms/pcf/_index.md,
/kubernetes/deployment/tanzu/pcf/_index.md,
/kubernetes/deployment/tanzu/pcf/_index/
]
---
This topic describes how to install and configure Redis Enterprise for Pivotal Platform (formerly Pivotal Cloud Foundry - PCF).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ description:
weight: 90
alwaysopen: false
categories: ["Platforms"]
aliases: /rs/getting-started/pcf/
aliases: [
/rs/getting-started/pcf/,
/platforms/pcf/backup-restore-pcf/,
/platforms/pcf/backup-restore-pcf.md,
/kubernetes/deployment/tanzu/pcf/backup-restore-pcf.md,
/kubernetes/deployment/tanzu/pcf/backup-restore-pcf/


]
---
This topic describes how to backup and restore Redis Enterprise for Pivotal Platform (formerly Pivotal Cloud Foundry - PCF).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@ description:
weight: 60
alwaysopen: false
categories: ["Platforms"]
aliases: /rs/getting-started/pcf/
aliases: [
/rs/getting-started/pcf/,
/platforms/pcf/using-pcf/,
/platforms/pcf/using-pcf.md,
/kubernetes/deployment/tanzu/pcf/using-pcf.md,
/kubernetes/deployment/tanzu/pcf/using-pcf/

]
---
This topic describes how to use Redis Enterprise Software (RS) for Pivotal Platform.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ aliases: [
/platforms/kubernetes/tasks/using-kustomize/,
/platforms/kubernetes/tasks/using-kustomize.md
/platforms/kubernetes/deployment/using-kustomize/,
/platforms/kubernetes/deployment/using-kustomize.md
/platforms/kubernetes/deployment/using-kustomize.md,
/kubernetes/deployment/using-kustomize.md,
/kubernetes/deployment/using-kustomize/
]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@ description:
weight: 100
alwaysopen: false
categories: ["Platforms"]
aliases: [
/platforms/faqs/,
/platforms/faqs.md
]
---
Here are some frequently asked questions about Redis Enterprise on integration platforms.

## What is an Operator?

An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/platforms/kubernetes/architecture/operator.md" >}}).
An operator is a [Kubernetes custom controller](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources#custom-controllers) which extends the native K8s API. Refer to the article [Redis Enterprise K8s Operator-based deployments – Overview]({{< relref "/kubernetes/architecture/operator.md" >}}).

## Does Redis Enterprise operator support multiple RECs per namespace?

Expand All @@ -34,7 +38,7 @@ kubectl describe rec <my-cluster-name>

The cluster admin user password is created by the operator during the deployment of the Redis Enterprise cluster (REC) and is stored in a Kubernetes [secret](https://kubernetes.io/docs/concepts/configuration/secret/).

See [Manage REC credentials]({{< relref "/platforms/kubernetes/security/manage_REC_credentials">}}) for instructions on changing the admin password.
See [Manage REC credentials]({{< relref "/kubernetes/security/manage_REC_credentials">}}) for instructions on changing the admin password.

## How is using Redis Enterprise operator superior to using Helm charts?

Expand All @@ -60,7 +64,7 @@ Connect to the UI by pointing your browser to `https://localhost:8443`

For nodes hosting the Redis Enterprise cluster [statefulSet](https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/) [pods](https://kubernetes.io/docs/concepts/workloads/pods/), follow the guidelines provided for Redis Enterprise in the [hardware requirements]({{< relref "/rs/administering/designing-production/hardware-requirements.md" >}}).

For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/platforms/kubernetes/memory/persistent-volumes.md" >}}).
For additional information please also refer to [Kubernetes operator deployment – persistent volumes]({{< relref "/kubernetes/memory/persistent-volumes.md" >}}).

## How to retrieve the username/password for a Redis Enterprise Cluster?

Expand Down Expand Up @@ -187,7 +191,7 @@ Also, some of the REC services must be able to increase default resource limits,

While the REC container runs as user 1001, there are no limits currently set on users and user groups in the default scc.yaml file. The psp.yaml example defines the specific uid.

The REC SCC definitions are only applied to the project namespace when you apply them to the namespace specific Service Account as described in the [OpenShift CLI deployment article]({{< relref "/platforms/kubernetes/deployment/openshift/openshift-cli" >}}).
The REC SCC definitions are only applied to the project namespace when you apply them to the namespace specific Service Account as described in the [OpenShift CLI deployment article]({{< relref "/kubernetes/deployment/openshift/openshift-cli" >}}).

REC PSP definitions are controlled with role-based access control (RBAC).
A cluster role allowing the REC PSP is granted to the redis-enterprise-operator service account
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ aliases: [
/platforms/kubernetes/concepts/logs.md,
/platforms/kubernetes/logs/,
/platforms/kubernetes/logs/_index.md,
/kubernetes/logs/_index.md,
/kubernetes/logs/_index/
]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ aliases: [
/platforms/kubernetes/tasks/run-log-collector-script.md,
/platforms/kubernetes/logs/collect-logs.md,
/platforms/kubernetes/logs/collect-logs/,
/kubernetes/logs/collect-logs.md,
/kubernetes/logs/collect-logs/
]

---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ categories: ["Platforms"]
aliases: [
/platforms/kubernetes/memory/,
/platforms/kubernetes/memory/_index.md,
/kubernetes/memory/_index.md,
/kubernetes/memory/_index/
]
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,22 @@ aliases: [
/platforms/kubernetes/pod-scheduling/,
/platforms/kubernetes/concepts/node-selection.md,
/platforms/kubernetes/concepts/node-selection,
/platforms/kubernetes/memory/node-selection.md
/platforms/kubernetes/memory/node-selection/
/platforms/kubernetes/memory/node-selection.md,
/platforms/kubernetes/memory/node-selection/,
/kubernetes/memory/node-selection.md,
/kubernetes/memory/node-selection/,

]

---

Many K8s cluster deployments have different kinds of nodes that have
Many Kubernetes cluster deployments have different kinds of nodes that have
different CPU and memory resources available for scheduling cluster workloads.
The Redis Enterprise operator has various abilities to control the scheduling
Redis Enterprise cluster node pods through properties specified in the
Redis Enterprise cluster CRD.
Redis Enterprise cluster custom resource definition (CRD).

A Redis Enterprise cluster is deployed as a StatefulSet which manages the Redis Enterprise cluster node pods.
A Redis Enterprise cluster (REC) is deployed as a StatefulSet which manages the Redis Enterprise cluster node pods.
The scheduler chooses a node to deploy a new Redis Enterprise cluster node pod on when:

- The cluster is created
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ aliases: [
/platforms/kubernetes/concepts/persistent-volumes.md,
/platforms/kubernetes/concepts/persistent-volumes/,
/platforms/kubernetes/memory/persistent-volumes/,
/platforms/kubernetes/memory/persistent-volumes.md
/platforms/kubernetes/memory/persistent-volumes.md,
/kubernetes/memory/persistent-volumes.md,
/kubernetes/memory/persistent-volumes/
]
---
To deploy a Redis Enterprise cluster with Redis Enterprise operator the
Expand Down
Loading