diff --git a/docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index efd3465ce22..25fd2b14d68 100644 --- a/docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/docs/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index 3ca93936f1f..61f65cbba77 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 13100f50109..01800259c55 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 7203d827091..e965bc9a8b1 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 6. Generate and View Traffic +title: Generate and View Traffic from Istio --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 38548a4921d..9644f8434c8 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 4. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index 150289745d7..ebf477eb829 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 5. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index af5b22672c5..314aebddf46 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 3. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 4b58db9ead3..1c05a3268d7 100644 --- a/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -11,7 +11,7 @@ If you are migrating Rancher to a new Kubernetes cluster, you don't need to inst ### Prerequisites -These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. +These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. :::caution @@ -21,12 +21,9 @@ It is required to use the same hostname that was set as the server URL in the fi Rancher version must be v2.5.0 and up -Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: +Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used. -- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) -- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) - -Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. +Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. ### 1. Install the rancher-backup Helm chart diff --git a/docs/integrations-in-rancher/fleet/fleet.md b/docs/integrations-in-rancher/fleet/fleet.md index 0db52a7e9e1..d8d1f44b282 100644 --- a/docs/integrations-in-rancher/fleet/fleet.md +++ b/docs/integrations-in-rancher/fleet/fleet.md @@ -12,7 +12,7 @@ Many users often manage over 10 clusters at a time. Given the proliferation of c - I need to deploy my monitoring stack (e.g., Grafana, Prometheus) across geographical regions, each with different retention policies. - I am a platform operator and want to provision clusters with all components using a scalable and safe operating model (GitOps). -- I am an application developer and want to get my latest changes to automatically into my development environment. +- I am an application developer and want my latest changes to automatically go into my development environment. ## Fleet with Rancher Prime diff --git a/docs/reference-guides/backup-restore-configuration/examples.md b/docs/reference-guides/backup-restore-configuration/examples.md index 0afd8a359fb..d00dce126ea 100644 --- a/docs/reference-guides/backup-restore-configuration/examples.md +++ b/docs/reference-guides/backup-restore-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Backup and Restore Examples --- diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index 9faf7e98213..6ec07fe1906 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 34c63378cbe..5dddf5eba8b 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml diff --git a/docs/reference-guides/monitoring-v2-configuration/examples.md b/docs/reference-guides/monitoring-v2-configuration/examples.md index c65722cfa97..d6ef1920256 100644 --- a/docs/reference-guides/monitoring-v2-configuration/examples.md +++ b/docs/reference-guides/monitoring-v2-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Monitoring V2 Configuration Examples --- @@ -8,20 +8,20 @@ title: Examples ### ServiceMonitor -An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) +See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML. ### PodMonitor -An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor. ### PrometheusRule -For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. +For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources. -An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule. ### Alertmanager Config -For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs). +See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs). diff --git a/static/img/install-rancher-prime-basics-create-new.png b/static/img/install-rancher-prime-basics-create-new.png new file mode 100644 index 00000000000..0d2a6104528 Binary files /dev/null and b/static/img/install-rancher-prime-basics-create-new.png differ diff --git a/static/img/install-rancher-prime-basics.png b/static/img/install-rancher-prime-basics.png new file mode 100644 index 00000000000..9939c73d814 Binary files /dev/null and b/static/img/install-rancher-prime-basics.png differ diff --git a/static/img/install-rancher-prime-bootstrap-password.png b/static/img/install-rancher-prime-bootstrap-password.png new file mode 100644 index 00000000000..a1da97ec51f Binary files /dev/null and b/static/img/install-rancher-prime-bootstrap-password.png differ diff --git a/static/img/install-rancher-prime-global-settings.png b/static/img/install-rancher-prime-global-settings.png new file mode 100644 index 00000000000..de26e71c846 Binary files /dev/null and b/static/img/install-rancher-prime-global-settings.png differ diff --git a/static/img/install-rancher-prime-home.png b/static/img/install-rancher-prime-home.png new file mode 100644 index 00000000000..4e799e0e682 Binary files /dev/null and b/static/img/install-rancher-prime-home.png differ diff --git a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index a9680505eaf..8b276ea2278 100644 --- a/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/versioned_docs/version-2.0-2.4/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index d6a00bb9afd..d11bad34119 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 929f03ca7ce..faa18fd7864 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index becffde4401..fc703971513 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 7. Generate and View Traffic +title: Generate and View Traffic --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md index 6df5cde370e..ce031a8a0cd 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/node-selectors.md @@ -1,5 +1,5 @@ --- -title: 3. Select the Nodes Where Istio Components Will be Deployed +title: Select the Nodes Where Istio Components Will be Deployed --- > **Prerequisite:** Your cluster needs a worker node that can designated for Istio. The worker node should meet the [resource requirements.](../../../explanations/integrations-in-rancher/istio/cpu-and-memory-allocations.md) diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index f90135bcf22..ac54b573e6d 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 5. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index 37c0d47eeab..cdca3098dd6 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 6. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index 29bf3db97d1..f47f613d0aa 100644 --- a/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/versioned_docs/version-2.0-2.4/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 4. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index e076f6d7528..0561a13e025 100644 --- a/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/versioned_docs/version-2.5/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index 76bdcc78c48..b2847bbe92e 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index d0d02e1e126..e46acb5d5c8 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 849197b482d..d6105392b51 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 6. Generate and View Traffic +title: Generate and View Traffic from Istio --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 3f0ede71d7f..cb4d2bd8093 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 4. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index e1e57f5983c..f20b52ccbd7 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 5. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index 0996a8f6c6a..e359b42cdae 100644 --- a/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/versioned_docs/version-2.5/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 3. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 141f0fe99c7..15aeb447a08 100644 --- a/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.5/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -16,10 +16,7 @@ It is required to use the same hostname that was set as the server URL in the fi Rancher version must be v2.5.0 and up -Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: - -- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) -- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) +Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used. Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. diff --git a/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/examples.md b/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/examples.md index 610cfab0650..f07d105adc6 100644 --- a/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/examples.md +++ b/versioned_docs/version-2.5/reference-guides/backup-restore-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Backup and Restore Examples --- diff --git a/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/examples.md b/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/examples.md index c65722cfa97..d6ef1920256 100644 --- a/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/examples.md +++ b/versioned_docs/version-2.5/reference-guides/monitoring-v2-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Monitoring V2 Configuration Examples --- @@ -8,20 +8,20 @@ title: Examples ### ServiceMonitor -An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) +See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML. ### PodMonitor -An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor. ### PrometheusRule -For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. +For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources. -An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule. ### Alertmanager Config -For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs). +See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs). diff --git a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index d45b57fc169..eca79248fdb 100644 --- a/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/versioned_docs/version-2.6/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index bb81cb623f5..5808f1a8946 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 13100f50109..01800259c55 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 7203d827091..e965bc9a8b1 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 6. Generate and View Traffic +title: Generate and View Traffic from Istio --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 38548a4921d..9644f8434c8 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 4. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index 150289745d7..ebf477eb829 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 5. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index af5b22672c5..314aebddf46 100644 --- a/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/versioned_docs/version-2.6/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 3. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index aef2bca7ef5..0d83a5c5ae4 100644 --- a/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.6/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -20,10 +20,7 @@ It is required to use the same hostname that was set as the server URL in the fi Rancher version must be v2.5.0 and up -Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: - -- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) -- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) +Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used. Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. diff --git a/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/examples.md b/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/examples.md index bab7533302e..dba8f0afc0c 100644 --- a/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/examples.md +++ b/versioned_docs/version-2.6/reference-guides/backup-restore-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Backup and Restore Examples --- diff --git a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/examples.md b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/examples.md index c65722cfa97..d6ef1920256 100644 --- a/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/examples.md +++ b/versioned_docs/version-2.6/reference-guides/monitoring-v2-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Monitoring V2 Configuration Examples --- @@ -8,20 +8,20 @@ title: Examples ### ServiceMonitor -An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) +See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML. ### PodMonitor -An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor. ### PrometheusRule -For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. +For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources. -An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule. ### Alertmanager Config -For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs). +See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs). diff --git a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index 484d86b20f0..aa45287e56f 100644 --- a/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/versioned_docs/version-2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index ccc2009b0bc..804f6d35d8a 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 13100f50109..01800259c55 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 7203d827091..e965bc9a8b1 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 6. Generate and View Traffic +title: Generate and View Traffic from Istio --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 38548a4921d..9644f8434c8 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 4. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index 150289745d7..ebf477eb829 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 5. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index af5b22672c5..314aebddf46 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 3. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 29f22ab6164..9e670da901d 100644 --- a/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.7/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -11,7 +11,7 @@ If you are migrating Rancher to a new Kubernetes cluster, you don't need to inst ### Prerequisites -These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. +These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. :::caution @@ -21,12 +21,9 @@ It is required to use the same hostname that was set as the server URL in the fi Rancher version must be v2.5.0 and up -Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: +Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used. -- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) -- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) - -Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. +Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. ### 1. Install the rancher-backup Helm chart diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md new file mode 100644 index 00000000000..dd6ed7e4b1f --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues.md @@ -0,0 +1,9 @@ +--- +title: Common Issues for Rancher Prime PAYG on AWS +--- + +This page covers some common issues that might arise when setting up the Rancher Prime PAYG offering on Amazon's AWS Marketplace. + +### Migrating Rancher to a different EKS Cluster + +When you migrate Rancher to a different EKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target EKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the AWS Marketplace. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md new file mode 100644 index 00000000000..9e7d770230a --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md @@ -0,0 +1,160 @@ +--- +title: Installing Rancher Prime PAYG on AWS +--- + +This page covers installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace. + +## Preparing your cluster + +### OIDC provider + +Your EKS cluster requires that you install an OIDC provider. To check that you've installed an OIDC provider, find the OIDC issuer with the following command. Substitute `` with the name of your EKS cluster and `` with the region where it is running: + +```shell +aws eks describe-cluster --name --region --query cluster.identity.oidc.issuer --output text +``` + +This should return a URL, such as `https://oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`. The part after `https://` (e.g. `oidc.eks.region.amazonaws.com/id/1234567890ABCDEF`) is the OIDC Provider Identity. The final section of the URL, `1234567890ABCDEF`, is the OIDC ID. + +Use the OIDC ID to check if the EKS cluster has a provider: + +```shell +aws iam list-open-id-connect-providers | grep +``` + +If the last command produces no output, create an OIDC provider: + +```shell +eksctl utils associate-iam-oidc-provider --cluster --region --approve +``` + +### IAM Role + +You must create an IAM role and an attached policy to provide the necessary permissions. The role name is passed as an argument during the Helm deployment. + +Create the role with a `` of your choosing (for example, `rancher-csp-iam-role`) and attach the required policy: + +```shell +eksctl create iamserviceaccount \ + --name rancher-csp-billing-adapter \ + --namespace cattle-csp-billing-adapter-system \ + --cluster \ + --region \ + --role-name --role-only \ + --attach-policy-arn 'arn:aws:iam::aws:policy/AWSMarketplaceMeteringFullAccess' \ + --approve +``` + +## Installing Rancher + +1. Log Helm into the AWS Marketplace Elastic Container Registry (ECR) to fetch the application. The AWS Marketplace ECR is always in the `us-east-1` region: + + ```shell + export HELM_EXPERIMENTAL_OCI=1 + + aws --region us-east-1 ecr get-login-password \ + | helm registry login --username AWS \ + --password-stdin 709825985650.dkr.ecr.us-east-1.amazonaws.com + ``` + +1. Install Rancher with Helm. Customize your Helm installation values if needed. + + :::note + + Rancher Prime uses cert-manager to issue and maintain its certificates. Rancher generates its own CA certificate and signs certificates with that CA. + + ::: + + The Rancher hostname must be resolvable by a public DNS. For more details, see [Prerequisites](prerequisites.md). For example, if the DNS name is `rancher.my.org`, then replace `` with `rancher.my.org` when running the `helm install` command. + + ```shell + helm install -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ + oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse/$REPOSITORY/rancher-cloud-helm/rancher-cloud \ + --version \ + --set rancherHostname=\ + --set rancherServerURL=https://\ + --set rancherReplicas= \ + --set rancherBootstrapPassword=\ + --set rancherIngressClassName=nginx \ + --set global.aws.accountNumber=\ + --set global.aws.roleName= + ``` + + :::note + + Monitor the logs for the `rancher-cloud` pod since it is deleted one minute after a successful or failed installation. + + ```shell + kubectl logs -f rancher-cloud -n cattle-rancher-csp-deployer-system + ``` + + ::: + +1. After a successful deployment, the following command should produce similar output: + + ```shell + kubectl get deployments --all-namespaces + ``` + +**Response:** + + ```shell + NAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE + cattle-csp-billing-adapter-system csp-rancher-usage-operator 1/1 1 1 30m + cattle-csp-billing-adapter-system rancher-csp-billing-adapter 1/1 1 1 30m + cattle-fleet-local-system fleet-agent 1/1 1 1 29m + cattle-fleet-system fleet-controller 1/1 1 1 29m + cattle-fleet-system gitjob 1/1 1 1 29m + cattle-provisioning-capi-system capi-controller-manager 1/1 1 1 28m + cattle-system rancher 1/1 1 1 32m + cattle-system rancher-webhook 1/1 1 1 29m + cert-manager cert-manager 1/1 1 1 32m + cert-manager cert-manager-cainjector 1/1 1 1 32m + cert-manager cert-manager-webhook 1/1 1 1 32m + ingress-nginx ingress-nginx-controller 1/1 1 1 33m + kube-system coredns 2/2 2 2 38m + ``` + +### Check Helm Chart Installation + +1. Check that the Helm chart installation completed: + +```shell +helm ls -n cattle-rancher-csp-deployer-system +``` + +2. Verify the status of the installation: + +```shell +helm status rancher-cloud -n cattle-rancher-csp-deployer-system +``` + +Refer to the [Troubleshooting](troubleshooting.md) section if installation fails. + +When Helm chart installation successfully completes, Rancher Prime will be installed. + +## Log into the Rancher Dashboard + +You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL, `https://`. The `` is the hostname you entered when you [installed Rancher](#installing-rancher). + +:::note + +The Rancher hostname must be resolvable by public DNS. For more details, see [Prerequisites](prerequisites.md). + +::: + +## Uninstalling Rancher Prime PAYG Offering + +Run the following command to uninstall Rancher Prime: + +```shell +helm uninstall -n cattle-rancher-csp-deployer-system rancher-cloud +``` + +Uninstalling Rancher Prime may not remove all of the Kubernetes resources created by Rancher. Run the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup. + +The best practice for uninstalling the Rancher Prime PAYG offering is to migrate any non-Rancher workloads to a different cluster and destroy the Rancher cluster. + +:::warning +Ensure that you prepare and migrate any non-Rancher workloads off of the cluster before you destroy the cluster. These resources are nonrecoverable. +::: diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md new file mode 100644 index 00000000000..9e6bb17301e --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md @@ -0,0 +1,14 @@ +--- +title: Prerequisites +--- + +Before using Rancher Prime on AWS as a pay-as-you-go (PAYG) offering, you need the following resources, information, and tools: + +- A Rancher-compatible EKS cluster. For more details, see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). Refer to [Creating an EKS cluster](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) for bringing up an EKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md). +- An ingress on the EKS cluster, so that Rancher is accessible from outside the cluster. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#5-install-an-ingress) for instructions on deploying Ingress-NGINX on an EKS cluster. +- The Load Balancer IP address. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#6-get-load-balancer-ip) for how to find it, then save the `EXTERNAL-IP`. +- The Rancher hostname. The hostname must be a fully qualified domain name (FQDN), and its corresponding IP address must be resolvable from a public DNS. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md#7-set-up-dns) for instructions on how to set up DNS. This DNS points to the `EXTERNAL-IP`. +- [`aws`](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html). +- [`curl`](https://curl.se/docs/install.html). +- [`eksctl`](https://eksctl.io/installation/). +- [`helm` (v3 or greater)](https://helm.sh/docs/intro/quickstart/#install-helm). diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md new file mode 100644 index 00000000000..747c842c85b --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting.md @@ -0,0 +1,59 @@ +--- +title: Troubleshooting Rancher Prime PAYG Cluster in AWS +--- + +This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offering. + +## Jobs and Pods + +Check the status of pods or jobs: + +```shell +kubectl get pods --all-namespaces +``` + +If a pod is not in a `Running` state, you can attempt to find the root cause with the following commands: + +- Describe pod: `kubectl describe pod -n ` +- Pod container logs: `kubectl logs -n ` +- Describe job: `kubectl describe job -n ` +- Logs from the containers of pods of the job: `kubectl logs -l job-name= -n ` + +## Recovering from Failed Pods + +1. If any of the pods aren't running, check the `rancher-cloud` pod: + + ```shell + kubectl get pods --all-namespaces | grep rancher-cloud + ``` + +1. If the `rancher-cloud` pod is in an `Error` state, wait for the pod to be deleted. This should take about one minute. + +1. Fix the problem and run: + + ```shell + helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ + oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse//rancher-cloud-helm/rancher-cloud --install \ + --version \ + --set rancherHostname= \ + --set rancherServerURL=https:// \ + --set rancherReplicas= \ + --set global.aws.accountNumber= \ + --set global.aws.roleName= + ``` + +## Rancher Usage Record Not Found + +When you attempt to retrieve a usage record, you might see the following message: + +```shell +Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record not found" Check Configuration, Retrieve generated configuration csp-config +``` + +To resolve the error, run: + +```shell +kubectl get configmap -n cattle-csp-billing-adapter-system csp-config -o yaml +``` + +If a configuration is not listed, you can attempt to find the root cause by checking the pod status and log. See [Jobs and Pods](#jobs-and-pods) for more details. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md new file mode 100644 index 00000000000..17d8f52198b --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -0,0 +1,31 @@ +--- +title: Upgrading Rancher Prime PAYG Cluster in AWS +--- + +The AWS Marketplace PAYG offering is tied to a billing adapter and the Rancher Prime version. These are periodically updated as new versions of the billing adapter or Rancher Prime are released. When a new update is available, the Helm chart is updated with new tags and digests, and a new version of the Helm chart is uploaded. + +To upgrade the deployed Helm chart to the latest version, run the following Helm command: + +```shell +helm upgrade -n cattle-rancher-csp-deployer-system rancher-cloud --create-namespace \ +oci://709825985650.dkr.ecr.us-east-1.amazonaws.com/suse//rancher-cloud-helm/rancher-cloud \ + --version \ + --set rancherHostname= \ + --set rancherServerURL=https:// \ + --set rancherReplicas= \ + --set rancherIngressClassName=nginx \ + --set global.aws.accountNumber= \ + --set global.aws.roleName= +``` + +To check if the upgraded Helm chart deployed successfully, run the following Helm command: + +```shell +helm ls -n cattle-rancher-csp-deployer-system +``` + +:::warning + +Rancher Prime PAYG customers have constraints on getting updates, based on the latest version SUSE has published to AWS. The latest available Rancher Prime version may trail slightly behind the latest Rancher release. + +::: diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md new file mode 100644 index 00000000000..cd68e5462b8 --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues.md @@ -0,0 +1,9 @@ +--- +title: Common Issues for Rancher Prime PAYG on Azure +--- + +This page covers some common issues that might arise when setting up the Rancher Prime PAYG offering on Microsoft's Azure Marketplace. + +### Migrating Rancher to a Different AKS Cluster + +When you migrate Rancher to a different AKS cluster by following the steps in [Rancher Backups and Disaster Recovery](../../../pages-for-subheaders/backup-restore-and-disaster-recovery.md), you must reinstall Rancher Prime on the target AKS cluster after restoring from the backup. Furthermore, the restored Rancher version must not be newer than the version available in the Azure Marketplace. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md new file mode 100644 index 00000000000..5dda266f125 --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md @@ -0,0 +1,104 @@ +--- +title: Installing Rancher Prime PAYG on Azure +--- + +This page covers installing the Rancher Prime PAYG offering on Microsoft's Azure Marketplace. + +## How to Install Rancher Prime PAYG + +The following steps describe how to create a new deployment of Rancher Prime from the Azure Marketplace page. + +1. Select the **Rancher Prime with 24x7 Support** offer (either **EU and UK only** or **non-EU and non-UK only**) that corresponds to the location where your account is registered. +1. Choose a plan from the dropdown menu. View the **Plans + Pricing** tab for more details about the plan. +1. Select **Create**. + +### Basics + +On the **Basics** tab, specify the **Project details** and **Instance details**: + +![Basics tab](/img/install-rancher-prime-basics.png) + +1. Select an existing **Subscription** from the dropdown menu. +1. Select an existing **Resource group** from the dropdown menu. + + :::note + + The **Create new** resource group feature is not supported. + + ![Create new resource group not supported](/img/install-rancher-prime-basics-create-new.png) + + ::: + +1. Select an existing **AKS Cluster Name** from the dropdown menu. +1. Choose an **Extension Resource name**. It can consist of alphanumeric characters and dots and must be between 2 and 253 characters long. +1. Select **Next**. + +### Rancher Configuration + +On the **Rancher Configuraion** tab, specify the following information: + +![Rancher Configuration](/img/install-rancher-prime-bootstrap-password.png) + +1. Enter the **Hostname** for Rancher. The Rancher hostname must be a fully qualified domain name (FQDN). The Rancher server URL will be created using this hostname. + :::note + + The IP address of the Rancher hostname must be resolvable by a public DNS. + + ::: +1. Using the slider, select the number of **Replicas**. +1. Choose and confirm a **Bootstrap Password**. During the first login, you will use the bootstrap password to authenticate to the Rancher dashboard. + :::note + + The current Rancher deployment exposes the bootstrap password in the Cluster configuration settings in the Azure Portal. Until this security issue is resolved, we suggest changing the Admin password after initial login, by editing your profile in the Rancher dashboard. + + ::: +1. Select **Next**. + +### Review + create + +1. On the **Review + create** tab, review the summary of the offer (Price, Basics, Rancher Configuration) and the link to **view automation template** (Azure Resource Manager Template). +1. Select **Create** to start the deployment. + +### Deployment Complete + +When the deployment successfully completes, Rancher Prime will be installed. + +:::note + +On the **Extensions + applications** page, the **Provisioning State** may show **Succeeded** even though the deployment may still be in progress. You can monitor the deployment progress by logging into the AKS cluster and looking at the **rancher-cloud** deployment. + +::: + +## Log into the Rancher Dashboard + +You may now log in to the Rancher dashboard by pointing your browser to the Rancher server URL `https://`. The `` is the hostname you entered when you [installed Rancher](#installing-rancher). + +:::note + +The Rancher hostname must be resolvable by public DNS. See the [Prerequisites](prerequisites.md) for more details. + +::: + +## How to Use Rancher + +After you login to Rancher Prime, you should notice the **Welcome to Rancher Prime** message at the top of the screen. + +![Rancher Prime Home](/img/install-rancher-prime-home.png) + +If your Rancher Prime PAYG deployment only has **Welcome to Rancher** at the top of the screen, make sure that you've updated to the latest version, and reset the branding to default (i.e., "suse") from **Global Settings**. + +![Global Settings](/img/install-rancher-prime-global-settings.png) + +## Rancher Prime PAYG Billing + +View billing information in the Azure Portal by going to **Home** > **Cost Management (subscription) | Cost analysis**. + +## Uninstalling Rancher Prime PAYG Offering + +Uninstalling Rancher Prime may not remove all of the Kubernetes resources created by Rancher. Run the [Rancher resource cleanup script](https://github.com/rancher/rancher-cleanup) to perform a more comprehensive cleanup. + +The best practice for uninstalling the Rancher Prime PAYG offering is to migrate any non-Rancher workloads to a different cluster and destroy the Rancher cluster. + +:::warning +Ensure that you prepare and migrate any non-Rancher workloads off of the cluster before you destroy the cluster. These resources are nonrecoverable. +::: diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites.md new file mode 100644 index 00000000000..aedcdd45b13 --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites.md @@ -0,0 +1,9 @@ +--- +title: Prerequisites +--- + +Before using Rancher Prime on Azure as a pay-as-you-go (PAYG) offering, you need the following resources, information, and tools: + +- A Rancher-compatible AKS cluster. For more details, see the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions/). You can only install the Rancher Prime PAYG offering onto clusters in regions where AKS and Azure Container Apps are available. See the [Azure documentation](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=container-apps,kubernetes-service®ions=all) for details. Refer to [Creating an AKS cluster](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#3-create-the-aks-cluster) for bringing up an AKS cluster to [install Rancher Prime PAYG](installing-rancher-prime.md). +- An ingress installed on the AKS cluster, so that Rancher is accessible outside the cluster. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#5-install-an-ingress) for instructions on deploying Ingress-NGINX on an AKS cluster. +- The Rancher hostname. The hostname must be a fully qualified domain name (FQDN), and its corresponding IP address must be resolvable from a public DNS. See the [Rancher documentation](../../../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md#7-set-up-dns) for instructions on how to set up DNS. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md new file mode 100644 index 00000000000..91671240aed --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting.md @@ -0,0 +1,88 @@ +--- +title: Troubleshooting Rancher Prime PAYG Cluster in Azure +--- + +This section contains information to help troubleshoot issues when installing the Rancher Prime PAYG offer and configuring the billing adapter. + +## Deployment + +After a successful deployment, check the status of the deployment. It should list similar pod and chart output as the example below. + +```shell +kubectl get deployments --all-namespaces +``` + +**Response:** + +```shell +NAMESPACE NAME READY UP-TO-DATE AVAILABLE AGE +cattle-csp-billing-adapter-system csp-rancher-usage-operator 1/1 1 1 8h +cattle-csp-billing-adapter-system rancher-csp-billing-adapter 1/1 1 1 8h +cattle-fleet-local-system fleet-agent 1/1 1 1 8h +cattle-fleet-system fleet-controller 1/1 1 1 8h +cattle-fleet-system gitjob 1/1 1 1 8h +cattle-provisioning-capi-system capi-controller-manager 1/1 1 1 8h +cattle-system rancher 3/3 3 3 8h +cattle-system rancher-webhook 1/1 1 1 8h +cert-manager cert-manager 1/1 1 1 8h +cert-manager cert-manager-cainjector 1/1 1 1 8h +cert-manager cert-manager-webhook 1/1 1 1 8h +ingress-nginx ingress-nginx-controller 1/1 1 1 9h +kube-system coredns 2/2 2 2 20h +kube-system coredns-autoscaler 1/1 1 1 20h +kube-system extension-agent 1/1 1 1 8h +kube-system extension-operator 1/1 1 1 8h +kube-system konnectivity-agent 2/2 2 2 20h +kube-system metrics-server 2/2 2 2 20h +``` + +## Jobs and Pods + +Check the status of pods or jobs: + +```shell +kubectl get pods --all-namespaces +``` + +If a pod is not in a `Running` state, you can attempt to find the root cause with the following commands: + +- Describe pod: `kubectl describe pod -n ` +- Pod container logs: `kubectl logs -n ` +- Describe job: `kubectl describe job -n -n ` + +## Rancher Usage Record Not Found + +When you attempt to retrieve a usage record, you might see the following message: + +```shell +Error from server (NotFound): cspadapterusagerecords.susecloud.net "rancher-usage-record not found" Check Configuration, Retrieve generated configuration csp-config +``` + +To resolve the error, run: + +```shell +kubectl get configmap -n cattle-csp-billing-adapter-system csp-config -o yaml +``` + +If a configuration is not listed, you can attempt to find the root cause by checking the pod status and log. See [Jobs and Pods](#jobs-and-pods) for more details. + +## Multiple Extensions of the Same Type + +When you attempt to install an extension of the same type, you will see the following message: + +```shell +Multiple extensions of same type is not allowed at this scope. (Code: ValidationFailed)" +``` + +The AKS cluster already has the extension with the same type. To resolve the error, uninstall the extension and re-deploy to the same cluster. + +## Resource Already Existing in your Cluster + +When you attempt to install a resource or extension that already exists, you will see the following message: + +```shell +Helm installation failed : Resource already existing in your cluster : Recommendation Manually delete the resource(s) that currently exist in your cluster and try installation again. To delete these resources run the following commands: kubectl delete -n : InnerError [rendered manifests contain a resource that already exists. Unable to continue with install: ServiceAccount "rancher" in namespace "cattle-system" exists and cannot be imported into the current release: invalid ownership metadata; annotation validation error: key "meta.helm.sh/release-name" must equal "test-nv2-reinstall": current value is "testnv2-plan"] +``` + +The AKS cluster already has the extension installed. To resolve the error, uninstall the extension as suggested in the error message, by deleting the resource via the kubectl command, or uninstall the extension in the Azure Console and re-deploy to the same cluster. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md new file mode 100644 index 00000000000..b39efd514e5 --- /dev/null +++ b/versioned_docs/version-2.7/integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md @@ -0,0 +1,17 @@ +--- +title: Upgrading Rancher Prime PAYG Cluster in Azure +--- + +The Azure Marketplace PAYG offering is periodically updated when a new version of Rancher Prime is released, and to optimize integration with Azure. + +To update to the latest supported version of the Rancher Prime PAYG offering, run the following command in the cluster Cloud Shell: + +```shell +az k8s-extension update --name $CLUSTER_EXTENSION_RESOURCE_NAME --cluster-name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --cluster-type managedClusters --version $VERSION_TO_BE_UPGRADED +``` + +:::warning + +Rancher Prime PAYG customers have constraints on getting updates, based on the latest version SUSE has published to Azure. The latest available Rancher Prime version may trail slightly behind the latest Rancher release. + +::: diff --git a/versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md b/versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md new file mode 100644 index 00000000000..3cbf9e8803b --- /dev/null +++ b/versioned_docs/version-2.7/pages-for-subheaders/aws-marketplace-payg-integration.md @@ -0,0 +1,509 @@ +--- +title: AWS Marketplace Pay-as-you-go (PAYG) Integration +--- + + + + + +## Overview + +Rancher Prime integrates with the [AWS Marketplace](https://aws.amazon.com/marketplace) as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to AWS customers, benefiting from a new pay-monthly pricing model available through the AWS Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in AWS, on-prem, or at the edge. To learn more, see our non-EMEA and EMEA AWS Marketplace offerings for Rancher Prime: + +- [Rancher Prime](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c) +- [Rancher Prime (EMEA Orders Only)](https://aws.amazon.com/marketplace/pp/prodview-ocgjwd5c2aj5i) + +## Limitations + +- Currently, you must be running Rancher v2.7.9. When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated. + +## How to Use + +1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites.md). +2. [Install the Rancher Prime PAYG offering on the AWS Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). + +## FAQ + +The following is a list of frequently asked questions. + +### Marketplace Listing + +#### What is the Rancher Prime listing on the AWS Marketplace? + +By selecting the Rancher Prime listing from the AWS Marketplace, customers can deploy Rancher to their Kubernetes environment with the advantage of having monthly billing via AWS. + +#### Where do I find the Rancher Prime listings? + +There are two listings in the AWS Marketplace. They are: + +- [Rancher Prime](https://aws.amazon.com/marketplace/pp/prodview-f2bvszurj2p2c) +- [Rancher Prime (EMEA Orders Only)](https://aws.amazon.com/marketplace/pp/prodview-ocgjwd5c2aj5i) + +#### Why are there two listings? Which one should I use? + +We have two listings for Rancher Prime, "EU, EEA, or UK Orders" and "non EU, EEA, or UK Orders." You should pick the listing that reflects where your AWS account gets billed. + +#### Are these listings available in all countries? + +No. The Rancher listing on AWS is not available to purchase in all countries. + +Your billing country is based on the AWS Account ID used to do the deployment. + +Please refer to the following lists of countries that can and cannot transact Rancher Prime via the AWS Marketplace. + +
+ Countries that can transact SUSE Rancher Support through the AWS Marketplace +
+
  • Australia, AU
    • +
  • Austria, AT
    • +
  • Bangladesh, BD
    • +
  • Belgium, BE
    • +
  • Bulgaria, BG
    • +
  • Cameroon, CM
    • +
  • Canada, CA
    • +
  • Chile, CL
    • +
  • Croatia, HR
    • +
  • Cyprus, CY
    • +
  • Czech Republic, CZ
    • +
  • Denmark, DK
    • +
  • Egypt, EG
    • +
  • Estonia, EE
    • +
  • Finland, FI
    • +
  • France, FR
    • +
  • Germany, DE
    • +
  • Greece, GR
    • +
  • Hungary, HU
    • +
  • Iceland, IS
    • +
  • India, IN
    • +
  • Indonesia, ID
    • +
  • Ireland, IE
    • +
  • Isle of Man, IM
    • +
  • Italy, IT
    • +
  • Kenya, KE
    • +
  • Kingdom of Saudi Arabia, SA
    • +
  • Korea, Republic of, KR
    • +
  • Latvia, LV
    • +
  • Lithuania, LT
    • +
  • Liechtenstein, LI
    • +
  • Luxembourg, LU
    • +
  • Malaysia, MY
    • +
  • Malta, MT
    • +
  • Netherlands, NL
    • +
  • New Zealand, NZ
    • +
  • Norway, NO
    • +
  • Poland, PL
    • +
  • Portugal, PT
    • +
  • Romania, RO
    • +
  • Russian Federation, RU
    • +
  • Singapore, SG
    • +
  • Slovakia, SK
    • +
  • Slovenia, SI
    • +
  • South Africa, ZA
    • +
  • Spain, ES
    • +
  • Sweden, SE
    • +
  • Switzerland, CH
    • +
  • Taiwan, Province of China, TW
    • +
  • Turkey, TR
    • +
  • United Kingdom, GB
    • +
  • United States, US
    • +
    +
    + +
    + Countries that cannot transact SUSE Rancher Support via the AWS Marketplace +
    +
  • Afghanistan, AF
    • +
  • Åland Islands, AX
    • +
  • Albania, AL
    • +
  • Algeria, DZ
    • +
  • American Samoa, AS
    • +
  • Andorra, AD
    • +
  • Angola, AO
    • +
  • Anguilla, AI
    • +
  • Antarctica, AQ
    • +
  • Antigua and Barbuda, AG
    • +
  • Argentina, AR
    • +
  • Armenia, AM
    • +
  • Aruba, AW
    • +
  • Azerbaijan, AZ
    • +
  • Bahamas, BS
    • +
  • Bahrain, BH
    • +
  • Barbados, BB
    • +
  • Belarus, BY
    • +
  • Belize, BZ
    • +
  • Benin, BJ
    • +
  • Bermuda, BM
    • +
  • Bhutan, BT
    • +
  • Bonaire, BQ
    • +
  • Bolivarian Republic of Venezuela, VE
    • +
  • Bosnia and Herzegovina, BA
    • +
  • Botswana, BW
    • +
  • Bouvet Island, BV
    • +
  • Brazil, BR
    • +
  • British Indian Ocean Territory, IO
    • +
  • Brunei Darussalam, BN
    • +
  • Burkina Faso, BF
    • +
  • Burundi, BI
    • +
  • Cambodia, KH
    • +
  • Cape Verde, CV
    • +
  • Cayman Islands, KY
    • +
  • Central African Republic, CF
    • +
  • Chad, TD
    • +
  • China, CN
    • +
  • Christmas Island, CX
    • +
  • Cocos (Keeling) Islands, CC
    • +
  • Colombia, CO
    • +
  • Comoros, KM
    • +
  • Congo, CG
    • +
  • Cook Islands, CK
    • +
  • Costa Rica, CR
    • +
  • Côte d'Ivoire, CI
    • +
  • Curaçao, CW
    • +
  • Democratic Republic of the Congo, CD
    • +
  • Djibouti, DJ
    • +
  • Dominica, DM
    • +
  • Dominican Republic, DO
    • +
  • Ecuador, EC
    • +
  • El Salvador, SV
    • +
  • Equatorial Guinea, GQ
    • +
  • Eritrea, ER
    • +
  • Ethiopia, ET
    • +
  • Falkland Islands (Malvinas), FK
    • +
  • Faroe Islands, FO
    • +
  • Federated States of Micronesia, FM
    • +
  • Fiji, FJ
    • +
  • Former Yugoslav Republic of Macedonia, MK
    • +
  • French Guiana, GF
    • +
  • French Polynesia, PF
    • +
  • French Southern Territories, TF
    • +
  • Gabon, GA
    • +
  • Gambia, GM
    • +
  • Georgia, GE
    • +
  • Ghana, GH
    • +
  • Gibraltar, GI
    • +
  • Greenland, GL
    • +
  • Grenada, GD
    • +
  • Guadeloupe, GP
    • +
  • Guam, GU
    • +
  • Guatemala, GT
    • +
  • Guernsey, GG
    • +
  • Guinea, GN
    • +
  • Guinea-Bissau, GW
    • +
  • Guyana, GY
    • +
  • Haiti, HT
    • +
  • Heard Island and McDonald Islands, HM
    • +
  • Holy See (Vatican City State), VA
    • +
  • Honduras, HN
    • +
  • Hong Kong, HK
    • +
  • Iraq, IQ
    • +
  • Israel, IL
    • +
  • Jamaica, JM
    • +
  • Japan, JP
    • +
  • Jersey, JE
    • +
  • Jordan, JO
    • +
  • Kazakhstan, KZ
    • +
  • Kiribati, KI
    • +
  • Kuwait, KW
    • +
  • Kyrgyzstan, KG
    • +
  • Lao People's Democratic Republic, LA
    • +
  • Lebanon, LB
    • +
  • Lesotho, LS
    • +
  • Liberia, LR
    • +
  • Libyan Arab Jamahiriya, LY
    • +
  • Macao, MO
    • +
  • Madagascar, MG
    • +
  • Malawi, MW
    • +
  • Maldives, MV
    • +
  • Mali, ML
    • +
  • Marshall Islands, MH
    • +
  • Martinique, MQ
    • +
  • Mauritania, MR
    • +
  • Mauritius, MU
    • +
  • Mayotte, YT
    • +
  • Mexico, MX
    • +
  • Mongolia, MN
    • +
  • Montenegro, ME
    • +
  • Montserrat, MS
    • +
  • Morocco, MA
    • +
  • Mozambique, MZ
    • +
  • Myanmar, MM
    • +
  • Namibia, NA
    • +
  • Nauru, NR
    • +
  • Nepal, NP
    • +
  • New Caledonia, NC
    • +
  • Nicaragua, NI
    • +
  • Niger, NE
    • +
  • Nigeria, NG
    • +
  • Niue, NU
    • +
  • Norfolk Island, NF
    • +
  • Northern Mariana Islands, MP
    • +
  • Oman, OM
    • +
  • Pakistan, PK
    • +
  • Palau, PW
    • +
  • Occupied Palestinian Territory, PS
    • +
  • Panama, PA
    • +
  • Papua New Guinea, PG
    • +
  • Paraguay, PY
    • +
  • Peru, PE
    • +
  • Philippines, PH
    • +
  • Pitcairn, PN
    • +
  • Plurinational State of Bolivia, BO
    • +
  • Puerto Rico, PR
    • +
  • Qatar, QA
    • +
  • Republic of Moldova, MD
    • +
  • Réunion, RE
    • +
  • Rwanda, RW
    • +
  • Saint Barthélemy, BL
    • +
  • Saint Helena, Ascension and Tristan da Cunha, SH
    • +
  • Saint Kitts and Nevis, KN
    • +
  • Saint Lucia, LC
    • +
  • Saint Martin, MF
    • +
  • Saint Pierre and Miquelon, PM
    • +
  • Saint Vincent and the Grenadines, VC
    • +
  • Samoa, WS
    • +
  • San Marino, SM
    • +
  • Sao Tome and Principe, ST
    • +
  • Senegal, SN
    • +
  • Serbia, RS
    • +
  • Seychelles, SC
    • +
  • Sierra Leone, SL
    • +
  • Sint Maarten, SX
    • +
  • Solomon Islands, SB
    • +
  • Somalia, SO
    • +
  • South Georgia and the South Sandwich Islands, GS
    • +
  • South Sudan, SS
    • +
  • Sri Lanka, LK
    • +
  • Suriname, SR
    • +
  • Svalbard and Jan Mayen, SJ
    • +
  • Swaziland, SZ
    • +
  • Tajikistan, TJ
    • +
  • Thailand, TH
    • +
  • Timor-Leste, TL
    • +
  • Togo, TG
    • +
  • Tokelau, TK
    • +
  • Tonga, TO
    • +
  • Trinidad and Tobago, TT
    • +
  • Tunisia, TN
    • +
  • Turkmenistan, TM
    • +
  • Turks and Caicos Islands, TC
    • +
  • Tuvalu, TV
    • +
  • Uganda, UG
    • +
  • Ukraine, UA
    • +
  • United Arab Emirates, AE
    • +
  • United Republic of Tanzania, TZ
    • +
  • United States Minor Outlying Islands, UM
    • +
  • Uruguay, UY
    • +
  • Uzbekistan, UZ
    • +
  • Vanuatu, VU
    • +
  • Viet Nam, VN
    • +
  • Virgin Islands, British, VG
    • +
  • Virgin Islands, U.S., VI
    • +
  • Wallis and Futuna, WF
    • +
  • Western Sahara, EH
    • +
  • Yemen, YE
    • +
  • Zambia, ZM
    • +
  • Zimbabwe, ZW
    • +
    +
    + +#### My AWS account is in the USA, but I want to deploy Rancher in another AWS region, a region that is in a country where I currently cannot transact Rancher Prime. Is this possible? + +Yes. As long as your AWS account is billed to one of the allowed countries, it is possible to deploy Rancher in any AWS regions. + +#### Is this listing available in China? + +While it is not possible to transact/bill Rancher Prime in China, it is possible to deploy into AWS regions in China. + +#### Can I still deploy Rancher using the "Rancher Setup" listing from the AWS Marketplace? + +"Rancher Setup" is no longer available via AWS Marketplace. Customers should deploy an EKS Cluster to host Rancher. Follow the steps in this [guide](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-amazon-eks.md) except for the Rancher installation. The Rancher product installation should be carried out as per [installing the Rancher Prime PAYG offering on Amazon's AWS Marketplace](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime.md). + +### Billing + +#### I have an existing Rancher Prime subscription. Can I use this on AWS? + +BYOS (Bring Your Own Subscription) Rancher deployments are supported on AWS; however, billing will not be via the AWS Marketplace. Once the existing subscription term ends, you can purchase Rancher Prime via the AWS Marketplace and reconfigure your cluster to support monthly billing via AWS. + +#### I have an existing Rancher Subscription purchased via the ’Rancher Premium Support’ listing on AWS. Isthis transferable to the new model? + +No. A new deployment of Rancher Prime is required to benefit from the new monthly billing model. + +#### I have an existing deployment covered by a Rancher subscription; can I use this new listing in AWS for new deployments? + +Yes. the listing works independently from your existing subscriptions. Please remember that support processes may be different for deployments using your existing subscription and those billed via the AWS Marketplace. + +#### Tell me more about how the billing for Rancher Prime works via AWS? + +When purchasing Rancher Prime via the AWS Marketplace, the billing is as follows: + +- Billing is monthly and handled via AWS Marketplace. +- Managed nodes are counted hourly when Rancher is active and added to a usage +total. +- An average node count is calculated for the month. +- There is a monthly usage charge for each node in the average node count. +- The monthly usage charge depends on the number of nodes in use. +- There is a 5-node minimum; if the average node count is less than 5 nodes, the +charge will be for 5 nodes. + +#### What are the pricing tiers? + +Rancher Prime has different pricing tiers when purchasing via the AWS Marketplace. This is based on the number of nodes which Rancher is managing. Details of the tiers are below. Please check the listing for further pricing information. + +| Tier | Nodes (from) | Nodes (to) | +| :------: | :----------: | :---------: | +| **1** | 5 | 15 | +| **2** | 16 | 50 | +| **3** | 51 | 100 | +| **4** | 101 | 250 | +| **5** | 251 | 1000 | +| **6** | 1001 | | + +#### Is there a way to try Rancher before purchasing? + +If using the Rancher Prime listing in the AWS Marketplace, billing will commence from the time of deployment. + +Rancher can be deployed manually using the standard documentation and repositories. When ready to benefit from a supported platform and have this billed via the AWS Marketplace, follow the available [documentation](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) to deploy Rancher Prime from the AWS Marketplace and migrate. + +#### How does SUSE calculate the ‘average number of managed nodes’ to bill for? + +The average node count is calculated by adding the number of managed nodes (counted hourly) and dividing by the number of hours Rancher has been active in the billing cycle. + +Below are three examples of how the average node count is calculated. Check the table below for the details. + +:::note + +In our example month, we are using 730 hours; this may differ depending on the number of days in the month and the billing cycle. + +::: + +- **Static usage:** Using Rancher to manage 10 nodes, for 1 month (730 hours) with no additional nodes added in the month. +- **Bursting Model:** Using Rancher to manage 10 nodes for 3 weeks (562 hours) in the month, bursting to 30 nodes for 1 week (168 hours). +- **Transient cluster:** A temporary deployment of Rancher on 20 nodes for 2 weeks (336 hours). + +| | Hours Active (Hours Rancher is active in the month) | Nodes (Managed Nodes counted at each check-in) | Usage total (Sum of nodes reported at each check-in) | Average Node Count (Usage total / hours active) | Note | +| ----------------- | :--: | :------------------------: | :----: | :--: | :------------------------------: | +| **Static Usage** | 730 | 10 | 7300 | 10 | 10 @ Tier 1 | +| **Bursting Model** | 730 | 10 (562 hrs), 30 (168 hrs) | 10660 | 15 | 15 @ Tier 1 (rounded from 14.6) | +| **Transient Cluster** | 336 | 20 | 6720 | 20 | 20 @ Tier 2 | + +#### Are special commercial terms available? + +Depending on the deployment, securing special commercial terms (e.g., an annual subscription) may be possible. This will be handled via an AWS Private offer. Please contact SUSE for more information. + +#### Can my spend on Rancher Prime count towards my AWS Enterprise Discount Program? + +Yes. Please contact your AWS Sales Team for more details. + +#### How do I purchase Rancher for additional nodes? + +Once Rancher has been deployed from the listing on AWS and billing is active, there is no need to make a specific purchase for additional nodes. Billing is dynamic and based on the number of nodes Rancher is managing. Just deploy or onboard additional clusters to Rancher as needed. + +#### Is this an annual commitment, will it auto-renew? + +By default, the Rancher Prime listing in AWS is billed on a monthly cycle, based on usage. Billing is ongoing for as long as Rancher is deployed. + +It is possible to set up an annual commitment via an AWS Private Offer; these will need to be reviewed and renewed at the end of the term, or the deployment will drop back to the default monthly billing cycle. + +### Technical (Billing) + +#### Do I need a Kubernetes cluster running in AWS to install Rancher and be billed via the AWS Marketplace? + +Yes. To benefit from monthly billing via the Marketplace, the primary Rancher cluster must be an EKS Cluster running in your AWS Account. + +#### Which Kubernetes distributions can the AWS Marketplace listing be deployed on? + +The AWS Marketplace listing for Rancher Prime with Marketplace billing must be deployed on Amazon EKS. Downstream clusters / managed worker nodes can run on any CNCF compliant Kubernetes platform, EKS, EKS-A, Rancher Kubernetes Engine, etc. + +#### What is the deployment mechanism? + +The AWS Marketplace listing for Rancher Prime is deployed using Helm. + +#### What is the easiest way to get started? + +One of the easiest ways to get started is to deploy the AWS Marketplace listing for Rancher Prime to an existing EKS cluster. Follow the instructions in the usage section, a Helm chart takes care of the installation and the setup for billing. + +#### What is the minimum version of Rancher required to support AWS Marketplace billing? + +The minimum version supporting marketplace billing is Rancher 2.7.9. + +#### What version of Rancher is installed when using the Marketplace listing? + +The AWS Marketplace listing for Rancher Prime is tied to a specific version of Rancher, typically the latest version available at the time of the listing update. Please check the listing for further information. + +#### I need a prior version of Rancher, can I still use the listing? + +No. There is no choice over the Rancher version when deploying using the AWS Marketplace listing. If a prior version of Rancher is required, this must be installed manually using the standard documentation. + +:::note + +Billing through AWS Marketplace may not be supported with previous versions. + +::: + +#### How often is the listing updated (including the version of Rancher, etc.)? + +The marketplace listing is tied to a specific version of Rancher, usually the latest version available at the time of listing. Typically, these are updated quarterly, or more frequently if there are security issues. + +#### I have many Kubernetes clusters across multiple AWS accounts, does the Rancher Prime billing still work and enable tiered pricing? + +Yes. Downstream clusters managed by Rancher can be deployed across single or multiple AWS accounts, on-premises, or even in other public clouds. Downstream nodes will report up to the primary Rancher deployment. Tiered pricing is enabled and billing will be routed to the AWS account in which the primary cluster is running. + +#### I have multiple independent clusters, each running a separate installation of the AWS Marketplace listing for Rancher Prime. How is this billed? + +As the Rancher Prime deployments are independent, each deployment is billed separately from the others. It is not possible to benefit from tiered pricing. + +#### If managing multiple independent Rancher clusters, consider custom terms from SUSE. How can I benefit from tiered pricing across all Rancher deployments? + +The primary Rancher cluster must be running on EKS in the AWS Cloud and running the AWS Marketplace listing for Rancher. To benefit from tiered pricing, managed clusters (downstream clusters) should be connected to the primary Rancher cluster. + +#### I have purchased multiple SUSE products from the AWS Marketplace (e.g., SUSE Manager, NeuVector Prime and now Rancher Prime). Does the AWS Marketplace billing method still work? + +Yes. The billing mechanism of each deployment is independent, each product will be billed separately via the AWS Marketplace. + +#### I already have an existing EKS cluster in place and want to add Rancher and have this billed via Marketplace. Is this possible? + +Yes. Simply deploy the AWS Marketplace listing for Rancher Prime. + +#### I already have an existing cluster, with Rancher deployed. Can I just install the marketplace version and have support billed via the AWS Marketplace? + +In order to benefit from monthly billing via the AWS Marketplace, the primary Rancher cluster needs to be deployed from the listing, it is then possible to migrate the existing Rancher configuration to the new deployment. + +Please follow the [documentation](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md) and be sure to back up the existing Rancher configuration. + +### Technical (Product) + +#### How do I get support? + +It is very simple to [open a support case](https://scc.suse.com/cloudsupport) with SUSE for Rancher Prime. Create a ‘supportconfig’ via the Rancher UI and upload the output to the SUSE Customer Center. The support config bundle can be exported from the Rancher console using the ‘Get Support’ button at the bottom of the page. For deployments when Rancher is managing multiple downstream clusters, export the support config bundle from the primary cluster only. + +If the billing mechanism on the primary cluster is active, a support case will be opened. Further details can be found in the [documentation](../integrations-in-rancher/cloud-marketplace/supportconfig.md). + +#### What are the resource requirements for installing Rancher on EKS? + +Please check the documentation for best practices. + +#### Is there any difference between Rancher Prime from the AWS Marketplace and the versions I can run in my own data center? + +Rancher Prime available in the AWS Marketplace is the same product, with the same functionality that you would run on-premises or with a manual installation. The only difference between deploying manually and deploying via the AWS Marketplace listing is the billing route. + +#### Does the primary cluster (responsible for billing) need to run 24/7? + +To ensure continuity with support, it is recommended that the primary Rancher cluster always remains active. + +#### What if the primary cluster responsible for billing is unable to connect to the AWS Billing framework? + +There may be multiple reasons why the primary cluster is unable to connect to the AWS framework, but it is the customer’s responsibility to ensure that the primary cluster is active and connected. Whilst the cluster is not connected to the billing framework, it is not possible to raise a support request. + +#### My primary cluster has been offline. What will happen with billing when reconnected? + +If the primary cluster is offline or disconnected from the AWS billing framework for a period of time, when it reconnects, the stored usage data will be uploaded to AWS and will appear on your next AWS bill. + +Depending on when in the month the primary cluster gets reconnected you may have several months of usage on your next billing cycle. + +#### Can the managed worker nodes reside on premises, at the edge or even on another cloud provider? + +Yes. Nodes can run anywhere. SUSE Rancher will count the total number of nodes managed regardless of where they are deployed. + +#### How do I get fixes and updates for Rancher? + +To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in AWS](../integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster.md). diff --git a/versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md b/versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md new file mode 100644 index 00000000000..052cc94bca9 --- /dev/null +++ b/versioned_docs/version-2.7/pages-for-subheaders/azure-marketplace-payg-integration.md @@ -0,0 +1,235 @@ +--- +title: Azure Marketplace Pay-as-you-go (PAYG) Integration +--- + + + + + +## Overview + +Rancher Prime integrates with the [Azure Marketplace](https://azuremarketplace.microsoft.com) as a pay-as-you-go (PAYG) offering. This brings the value of running and managing Kubernetes environments to Azure customers, benefiting from a new pay-monthly pricing model available through the Azure Marketplace. This listing will enable you to manage any CNCF-certified Kubernetes distribution in Azure, on-prem, or at the edge. To learn more, see our non-EMEMA and EMEA Azure Marketplace offerings for Rancher Prime: + +- [Rancher Prime with 24x7 Support](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suse.rancher-prime-llc/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suse.rancher-prime-llcpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%221dafcf16-920e-46ea-80c9-dc85c6bd3a17%22%7D/searchTelemetryId/c2300fb7-ba7b-462a-ba57-a37cb5e2822d) +- [Rancher Prime with 24x7 Support (EMEA Orders Only)](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suseirelandltd1692213356027.rancher-prime-ltd/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suseirelandltd1692213356027.rancher-prime-ltdpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%22c6b1d79a-b577-47b0-90e5-41e6c49688ab%22%7D/searchTelemetryId/1793144d-e0d9-466e-8e36-dfeddc73163b) + +## Limitations + +- Currently, you must be running Rancher v2.7.9. When you deploy a supported PAYG version, you can update to newer versions of Rancher when the listing is updated. + +## How to Use + +1. Complete the [prerequisite steps](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites.md). +2. [Install the Rancher Prime PAYG offering on the Azure Marketplace](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime.md). + +## FAQ + +The following is a list of frequently asked questions. + +### Marketplace Listing + +#### What is the Rancher Prime listing on the Azure Marketplace? + +By selecting the Rancher Prime listing in the Azure Marketplace, customers can deploy Rancher to their Microsoft Azure Kubernetes Service (AKS) cluster environment to manage any downstream CNCF-certified Kubernetes distribution with the advantage of having monthly billing for Rancher Prime via Microsoft Azure. + +**Where do I find the Rancher Prime listings?** + +There are two listings in the Azure Marketplace. They are: + +- [Rancher Prime with 24x7 Support](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suse.rancher-prime-llc/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suse.rancher-prime-llcpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%221dafcf16-920e-46ea-80c9-dc85c6bd3a17%22%7D/searchTelemetryId/c2300fb7-ba7b-462a-ba57-a37cb5e2822d) +- [Rancher Prime with 24x7 Support (EMEA Orders Only)](https://portal.azure.com/#view/Microsoft_Azure_Marketplace/GalleryItemDetailsBladeNopdl/id/suseirelandltd1692213356027.rancher-prime-ltd/selectionMode~/false/resourceGroupId//resourceGroupLocation//dontDiscardJourney~/false/selectedMenuId/home/launchingContext~/%7B%22galleryItemId%22%3A%22suseirelandltd1692213356027.rancher-prime-ltdpay-as-you-go%22%2C%22source%22%3A%5B%22GalleryFeaturedMenuItemPart%22%2C%22VirtualizedTileDetails%22%5D%2C%22menuItemId%22%3A%22home%22%2C%22subMenuItemId%22%3A%22Search%20results%22%2C%22telemetryId%22%3A%22c6b1d79a-b577-47b0-90e5-41e6c49688ab%22%7D/searchTelemetryId/1793144d-e0d9-466e-8e36-dfeddc73163b) + +#### Why are there two listings? Which one should I use? + +There are two listings for Rancher Prime to accommodate Microsoft Azure billing regions. You should pick the listing that reflects where your Azure account gets billed. + +#### Are these listings available in all countries? + +No. Due to billing limitations and other restrictions, the Rancher Prime Azure Marketplace listing may not be purchasable in all countries. The Azure account you use for deployment determines your billing country. Contact your Azure Sales Team for more details. + +#### My Azure account is in the USA, but I want to deploy Rancher in another Azure region, a region that is in a country where I currently cannot transact Rancher Prime. Is this possible? + +Yes. As long as your Azure account is billed to one of the allowed countries, it is possible to deploy Rancher Prime in any Azure region. + +#### Is this listing available in China? + +While it is not possible to transact/bill Rancher Prime in China, it is possible to deploy into Azure regions in China. + +### Billing + +#### I have an existing Rancher Prime subscription; can I use this on Azure? + +Self-installed BYOS (Bring Your Own Subscription) Rancher Prime deployments are supported on Azure; however, billing will not be via the Azure Marketplace. Once the existing subscription term ends, you can purchase Rancher Prime via the Azure Marketplace and reconfigure your cluster to support monthly billing via Azure. + +#### I have an existing deployment covered by a Rancher subscription; can I use this new listing in the Azure Marketplace for new deployments? + +Yes. the listing works independently from your existing Rancher Prime subscriptions. Only deployments through the marketplace listing will be billed through Azure. Support is always direct from SUSE. + +#### Tell me more about how the billing for Rancher Prime works via Azure? + +When purchasing Rancher Prime via the Azure Marketplace, the billing is as follows: + +- Billing is monthly and handled via Azure. +- Managed nodes are counted hourly when Rancher is active and added to a usage total. +- An average node count is calculated for the month. +- There is a monthly usage charge for each node in the average node count. +- The monthly usage charge depends on the number of nodes in use. +- There is a 5-node minimum; if the average node count is less than 5 nodes, the charge will be for 5 nodes. + +#### What are the pricing tiers? + +Rancher Prime has different pricing tiers when purchasing via the Azure Marketplace. This is based on the number of nodes that Rancher is managing. Details of the tiers are shown below. Please check the listing for further pricing information. + +| Tier | Nodes (from) | Nodes (to) | +| :------: | :----------: | :---------: | +| **1** | 5 | 15 | +| **2** | 16 | 50 | +| **3** | 51 | 100 | +| **4** | 101 | 250 | +| **5** | 251 | 1000 | +| **6** | 1001 | | + +#### Is there a way to try Rancher before purchasing? + +If using the Rancher Prime listing in the Azure Marketplace, billing will commence from the time of deployment. You can try Rancher by deploying it per standard documentation. When ready to benefit from a supported platform and have this billed through Azure, deploy Rancher Prime via the Azure Marketplace and migrate your configuration. + +#### How does SUSE calculate the ‘average number of managed nodes’ to bill for? + +The average node count is calculated by adding the number of managed nodes (counted hourly) and dividing by the number of hours Rancher has been active in the billing cycle. Three examples are shown in the table below. + +:::note + +In our example month, we are using 730 hours; this may differ depending on the number of days in the month and the billing cycle. + +::: + +- **Static Usage:** +Using Rancher to manage 10 nodes for 1 month (730 hours) with no additional nodes added in the month. +- **Bursting Model:** +Using Rancher to manage 10 nodes for 3 weeks (562 hours) in the month and bursting to 30 nodes for 1 week (168 hours). +- **Transient Cluster:** +A temporary deployment of Rancher on 20 nodes for 2 weeks (336 hours). + +| | Hours Active (Hours Rancher is active in the month) | Nodes (Managed Nodes counted at each check-in) | Usage total (Sum of nodes reported at each check-in) | Average Node Count (Usage total / hours active) | Note | +| ----------------- | :--: | :------------------------: | :----: | :--: | :------------------------------: | +| **Static Usage** | 730 | 10 | 7300 | 10 | 10 @ Tier 1 | +| **Bursting Model** | 730 | 10 (562 hrs), 30 (168 hrs) | 10660 | 15 | 15 @ Tier 1 (rounded from 14.6) | +| **Transient Cluster** | 336 | 20 | 6720 | 20 | 20 @ Tier 2 | + +#### Are special commercial terms available? + +Depending on the deployment, securing special commercial terms (e.g., an annual subscription) may be possible. This will be handled via an Azure private offer. Please contact SUSE for more information. + +#### Can my spend on Rancher Prime count towards my MACC Program? + +Yes. Contact your Azure Sales Team for more details. + +#### How do I purchase Rancher for additional nodes? + +Once Rancher Prime has been deployed from the Azure Marketplace and billing is active, there is no need to make a specific purchase for additional nodes. Billing is dynamic and based on the number of nodes Rancher is managing. Just deploy or onboard additional clusters to Rancher as needed. + +#### Is this an annual commitment, will it auto-renew? + +By default, the Rancher Prime listing is billed on a monthly cycle, based on usage. Billing is ongoing for as long as Rancher Prime is deployed. + +It is possible to set up an annual commitment via an Azure Private Offer; these will need to be reviewed and renewed at the end of the term, or the deployment will drop back to the default monthly billing cycle. + +### Technical + +#### Do I need a Kubernetes cluster running in Azure to install Rancher and be billed via the Azure Marketplace? + +Yes. To benefit from monthly billing via Azure, the primary Rancher cluster must be an Azure Kubernetes Service (AKS) cluster running in your Azure account. + +#### Which Kubernetes distributions can the Rancher Prime Azure Marketplace listing be deployed on? + +The Rancher Prime marketplace listing must be deployed on Azure Kubernetes Service (AKS). Downstream/managed clusters can run any supported Kubernetes platform: RKE, RKE2, EKS, GKE, vanilla Kubernetes, OpenShift, Mirantis Kubernetes Engine, etc. See Supported Platforms for more details. + +#### What is the deployment mechanism? + +The Rancher Prime marketplace listing is deployed using Azure’s CNAB (with Helm inside). + +#### What is the easiest way to get started? + +One of the easiest ways to get started is to deploy the Rancher Prime marketplace listing to an existing AKS cluster. Follow the instructions in the usage section of the listing. A Helm chart takes care of installation and billing setup. + +#### What is the minimum version of Rancher required to support Azure Marketplace billing? + +The minimum version supporting marketplace billing is Rancher 2.7.9. + +#### What version of Rancher is installed when using the marketplace listing? + +The Rancher Prime marketplace listing is tied to a specific version of Rancher, typically the latest version available at the time of the listing update. Check the listing for further information. + +#### I need a prior version of Rancher; can I still use the listing? + +No. There is no choice over the Rancher version when deploying using the Azure Marketplace listing. If a prior version of Rancher is required, this must be installed manually using the standard documentation. + +:::note + +Billing through the Azure Marketplace may not be supported with earlier versions. + +::: + +#### How often is the listing updated (including the version of Rancher, etc.)? + +The marketplace listing is tied to a specific version of Rancher, usually it is the latest version available at the time the listing was last updated. Typically, the marketplace listing is updated quarterly, or more frequently to address any new security issues. + +#### I have many Kubernetes clusters across multiple Azure accounts; does the Rancher Prime billing still work and enable tiered pricing? + +Yes. Downstream/managed clusters can be deployed across single or multiple Azure accounts, on-premises, and in other public clouds. Downstream/managed nodes report up to Rancher Prime, enabling tiered pricing with billing routed to the Azure account in which the managing Rancher Prime cluster is running. + +#### I have multiple independent clusters, each running a separate installation of the Rancher Prime Azure Marketplace listing. How is this billed? + +As the Rancher Prime deployments are independent, each deployment is billed separately from the others. It is not possible to benefit from tiered pricing. If managing multiple independent Rancher Prime clusters, consider custom terms from SUSE. + +#### How can I benefit from tiered pricing across all Rancher deployments? + +The primary Rancher Prime cluster must be running on AKS in Microsoft Azure, deployed through the marketplace listing. To benefit from tiered pricing, downstream/managed clusters should be imported into the primary Rancher Prime cluster. + +#### I have purchased multiple SUSE products from the Azure Marketplace (e.g., SUSE Manager, NeuVector Prime, Rancher Prime). Does the Azure Marketplace billing method still work? + +Yes. The billing mechanisms for the deployments are independent and are billed separately via the Azure Marketplace. + +#### I already have an existing AKS cluster in place and want to add Rancher Prime to it and be billed through the Azure Marketplace. Is this possible? + +Yes. Simply deploy the Rancher Prime to the cluster with the Azure Marketplace listing. + +#### I already deployed Rancher to an existing AKS cluster. Can I just install the marketplace version to enable Azure Marketplace billing? + +No. You need to deploy Rancher Prime with the Azure Marketplace listing and migrate the existing Rancher configuration to this new deployment. Be sure that you back up your existing Rancher configuration. + +### Technical (Product) + +#### How do I get support? + +It is very simple to [open a support case](https://scc.suse.com/cloudsupport) with SUSE for Rancher Prime. Create a ‘supportconfig’ via the Rancher UI (click Get Support under the hamburger menu and follow instructions), then upload the ‘supportconfig’ output to the SUSE Customer Center. If the billing mechanism is active, a support case will be opened. See Supportconfig bundle in the Rancher [documentation](../integrations-in-rancher/cloud-marketplace/supportconfig.md) for more details. + +:::note + +For deployments where Rancher Prime is managing multiple downstream clusters, be sure to export the ‘supportconfig’ bundle from the primary cluster only. + +::: + +#### What are the resource requirements for installing Rancher on AKS? + +Check the documentation for [best practices](../pages-for-subheaders/installation-requirements.md#hosted-kubernetes). + +#### Is there any difference between Rancher Prime from Azure Marketplace and the versions I can run in my own data center? + +Rancher Prime available in the Azure Marketplace is the same product, with the same functionality that you would install manually in the cloud or on-premises. The only difference between deploying manually and deploying via the marketplace listing is the billing route. + +#### Does the primary cluster (responsible for billing) need to run 24/7? + +To ensure continuity of support, it is recommended that the primary Rancher Prime cluster always remain active. + +#### What if the primary cluster responsible for billing is unable to connect to the Azure billing framework? + +There may be multiple reasons why the primary cluster is unable to connect to the Azure billing framework, but it is the customer’s responsibility to ensure that the primary cluster is active and connected. While the cluster is not connected to the billing framework, it is not possible to raise a support request. + +#### My primary cluster has been offline. What will happen with billing when reconnected? + +If the Racher Prime cluster is offline or disconnected from the Azure billing framework for a period of time, when it reconnects, the stored usage data will be uploaded to Azure and will appear on your next Azure bill. Depending on the month when the primary cluster gets reconnected you may have several months of usage on your next billing cycle. + +#### How do I get fixes and updates for Rancher? + +To update to the latest version of the Rancher Prime PAYG offering supported in the marketplace listing, please see [upgrading Rancher Prime PAYG cluster in Azure](../integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster.md). diff --git a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/examples.md b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/examples.md index bab7533302e..dba8f0afc0c 100644 --- a/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/examples.md +++ b/versioned_docs/version-2.7/reference-guides/backup-restore-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Backup and Restore Examples --- diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index 9faf7e98213..6ec07fe1906 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 5ab4deb37fe..44b7f28bd26 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml diff --git a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/examples.md b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/examples.md index c65722cfa97..d6ef1920256 100644 --- a/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/examples.md +++ b/versioned_docs/version-2.7/reference-guides/monitoring-v2-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Monitoring V2 Configuration Examples --- @@ -8,20 +8,20 @@ title: Examples ### ServiceMonitor -An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) +See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML. ### PodMonitor -An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor. ### PrometheusRule -For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. +For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources. -An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule. ### Alertmanager Config -For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs). +See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs). diff --git a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md index efd3465ce22..25fd2b14d68 100644 --- a/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md +++ b/versioned_docs/version-2.8/getting-started/quick-start-guides/deploy-rancher-manager/vagrant.md @@ -1,5 +1,5 @@ --- -title: Vagrant Quick Start +title: Rancher Vagrant Quick Start --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md index 3ca93936f1f..61f65cbba77 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-cluster.md @@ -1,5 +1,5 @@ --- -title: 1. Enable Istio in the Cluster +title: Enable Istio in the Cluster --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md index 13100f50109..01800259c55 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/enable-istio-in-namespace.md @@ -1,5 +1,5 @@ --- -title: 2. Enable Istio in a Namespace +title: Enable Istio in a Namespace --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index 7203d827091..e965bc9a8b1 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -1,5 +1,5 @@ --- -title: 6. Generate and View Traffic +title: Generate and View Traffic from Istio --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md index 38548a4921d..9644f8434c8 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-istio-gateway.md @@ -1,5 +1,5 @@ --- -title: 4. Set up the Istio Gateway +title: Set up the Istio Gateway --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md index 150289745d7..ebf477eb829 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/set-up-traffic-management.md @@ -1,5 +1,5 @@ --- -title: 5. Set up Istio's Components for Traffic Management +title: Set up Istio's Components for Traffic Management --- diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md index af5b22672c5..314aebddf46 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/use-istio-sidecar.md @@ -1,5 +1,5 @@ --- -title: 3. Add Deployments and Services with the Istio Sidecar +title: Add Deployments and Services with the Istio Sidecar --- diff --git a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md index 4b58db9ead3..1c05a3268d7 100644 --- a/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md +++ b/versioned_docs/version-2.8/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md @@ -11,7 +11,7 @@ If you are migrating Rancher to a new Kubernetes cluster, you don't need to inst ### Prerequisites -These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. +These instructions assume that you have [created a backup](back-up-rancher.md) and already installed a new Kubernetes cluster where Rancher will be deployed. The backup is specific to the Rancher application and can only migrate the Rancher application. :::caution @@ -21,12 +21,9 @@ It is required to use the same hostname that was set as the server URL in the fi Rancher version must be v2.5.0 and up -Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. One of Rancher's Kubernetes distributions may also be used: +Rancher can be installed on any Kubernetes cluster, including hosted Kubernetes clusters such as Amazon EKS clusters. For help installing Kubernetes, refer to the documentation of the Kubernetes distribution. A Rancher-created Kubernetes distributions such as, but not limited to, [RKE](https://rke.docs.rancher.com/installation) or [K3s](https://docs.k3s.io/installation) may also be used. -- [RKE Kubernetes installation docs](https://rancher.com/docs/rke/latest/en/installation/) -- [K3s Kubernetes installation docs](https://rancher.com/docs/k3s/latest/en/installation/) - -Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. +Since Rancher can be installed on any Kubernetes cluster, you can use this backup and restore method to migrate Rancher from one Kubernetes cluster to any other Kubernetes cluster. This method *only* migrates Rancher-related resources and won't affect other applications on the cluster. Refer to the [support matrix](https://www.suse.com/lifecycle/) to identify which Kubernetes cluster types and versions are supported for your Rancher version. ### 1. Install the rancher-backup Helm chart diff --git a/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md b/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md index 0db52a7e9e1..09bc89db026 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/fleet/fleet.md @@ -12,7 +12,7 @@ Many users often manage over 10 clusters at a time. Given the proliferation of c - I need to deploy my monitoring stack (e.g., Grafana, Prometheus) across geographical regions, each with different retention policies. - I am a platform operator and want to provision clusters with all components using a scalable and safe operating model (GitOps). -- I am an application developer and want to get my latest changes to automatically into my development environment. +- I am an application developer and want my latest changes to automatically go into my development environment. ## Fleet with Rancher Prime diff --git a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/examples.md b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/examples.md index 0afd8a359fb..d00dce126ea 100644 --- a/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/examples.md +++ b/versioned_docs/version-2.8/reference-guides/backup-restore-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Backup and Restore Examples --- diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md index a776a3c23bd..9d321b9d3cc 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/k3s-cluster-configuration.md @@ -231,6 +231,7 @@ spec: kubernetesVersion: v1.26.7+k3s1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: {} etcd: snapshotRetention: 5 @@ -307,10 +308,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/k3s/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by K3s. +For more information about how K3s manges packaged components, please refer to [K3s documentation](https://docs.k3s.io/installation/packaged-components). + Example: ```yaml diff --git a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md index 9e4604f28de..07035bb6227 100644 --- a/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md +++ b/versioned_docs/version-2.8/reference-guides/cluster-configuration/rancher-server-configuration/rke2-cluster-configuration.md @@ -280,6 +280,7 @@ spec: kubernetesVersion: v1.25.12+rke2r1 localClusterAuthEndpoint: {} rkeConfig: + additionalManifest: "" chartValues: rke2-calico: {} etcd: @@ -337,10 +338,37 @@ spec: ``` +### additionalManifest + +Specify additional manifests to deliver to the control plane nodes. + +The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. + +Example: + +```yaml +additionalManifest: |- + apiVersion: v1 + kind: Namespace + metadata: + name: name-xxxx +``` + + +:::note + +If you want to customize system charts, you should use the `chartValues` field as described below. + +Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. + +::: + ### chartValues Specify the values for the system charts installed by RKE2. +For more information about how RKE2 manges packaged components, please refer to [RKE2 documentation](https://docs.rke2.io/helm). + Example: ```yaml diff --git a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/examples.md b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/examples.md index c65722cfa97..d6ef1920256 100644 --- a/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/examples.md +++ b/versioned_docs/version-2.8/reference-guides/monitoring-v2-configuration/examples.md @@ -1,5 +1,5 @@ --- -title: Examples +title: Monitoring V2 Configuration Examples --- @@ -8,20 +8,20 @@ title: Examples ### ServiceMonitor -An example ServiceMonitor custom resource can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) +See the official prometheus-operator GitHub repo for an example [ServiceMonitor](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml) YAML. ### PodMonitor -An example PodMonitor can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/example-app-pod-monitor.yaml) An example Prometheus resource that refers to it can be found [here.](https://github.com/prometheus-operator/prometheus-operator/blob/master/example/user-guides/getting-started/prometheus-pod-monitor.yaml) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/getting-started/#using-podmonitors) for an example PodMonitor and an example Prometheus resource that refers to a PodMonitor. ### PrometheusRule -For users who are familiar with Prometheus, a PrometheusRule contains the alerting and recording rules that you would normally place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). +A PrometheusRule contains the alerting and recording rules that you would usually place in a [Prometheus rule file](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). -For a more fine-grained application of PrometheusRules within your cluster, the ruleSelector field on a Prometheus resource allows you to select which PrometheusRules should be loaded onto Prometheus based on the labels attached to the PrometheusRules resources. +For a more fine-grained approach, the `ruleSelector` field on a Prometheus resource can select which PrometheusRules should be loaded onto Prometheus, based on the labels attached to the PrometheusRules resources. -An example PrometheusRule is on [this page.](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/user-guides/alerting.md) +See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/user-guides/alerting/) for an example PrometheusRule. ### Alertmanager Config -For an example configuration, refer to [this section](./receivers.md#example-alertmanager-configs). +See the Rancher docs page on Receivers for an example [Alertmanager config](./receivers.md#example-alertmanager-configs). diff --git a/versioned_sidebars/version-2.7-sidebars.json b/versioned_sidebars/version-2.7-sidebars.json index 8ff69b7de05..2a5a071cafe 100644 --- a/versioned_sidebars/version-2.7-sidebars.json +++ b/versioned_sidebars/version-2.7-sidebars.json @@ -1108,6 +1108,38 @@ "integrations-in-rancher/cloud-marketplace/aws-cloud-marketplace/common-issues" ] }, + { + "type": "category", + "label": "AWS Marketplace Pay-as-you-go (PAYG)", + "link": { + "type": "doc", + "id": "pages-for-subheaders/aws-marketplace-payg-integration" + }, + "items": [ + "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/prerequisites", + "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/installing-rancher-prime", + "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/upgrading-rancher-payg-cluster", + "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/troubleshooting", + "integrations-in-rancher/cloud-marketplace/aws-marketplace-payg-integration/common-issues" + + ] + }, + { + "type": "category", + "label": "Azure Marketplace Pay-as-you-go (PAYG)", + "link": { + "type": "doc", + "id": "pages-for-subheaders/azure-marketplace-payg-integration" + }, + "items": [ + "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/prerequisites", + "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/installing-rancher-prime", + "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/upgrading-rancher-payg-cluster", + "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/troubleshooting", + "integrations-in-rancher/cloud-marketplace/azure-marketplace-payg-integration/common-issues" + + ] + }, "integrations-in-rancher/cloud-marketplace/supportconfig" ] },