Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify "Linux dependencies" for vSphere #960

Merged
merged 86 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
db675f6
Clarify "Linux dependencies" for vSphere
lindhe Oct 26, 2023
01c0d15
Add note regarding rancher pentest reports public availability (#961)
pdellamore Oct 26, 2023
22dbffc
Add redirects for dashboard links
btat Oct 27, 2023
3ae3004
Merge pull request #962 from btat/redirects-for-ui
btat Oct 27, 2023
5a0e3c4
Updates to the Global roles for new 2.8 features (#898)
MbolotSuse Oct 27, 2023
9615b78
#857 Add a API quickstart page under the (to be added) API section (#…
martyav Oct 30, 2023
2fe51f1
Fix version-2.8 broken links
btat Oct 31, 2023
f154dbf
Merge pull request #965 from btat/broken-links-2023-10
btat Oct 31, 2023
0343d14
Update header: More from SUSE
btat Oct 31, 2023
63604ab
Fix quoting (single vs double) consistency
btat Oct 31, 2023
b7626ba
Fix link rendering issue
btat Nov 1, 2023
8033f02
Merge pull request #967 from btat/rendering
btat Nov 1, 2023
791c6ad
Add 2.7.9 entry to versions table
btat Nov 1, 2023
687d996
Add initial Opni landing page
ml8mr Nov 2, 2023
7b1c47a
Merge pull request #969 from ml8mr/landing-page-opni
btat Nov 2, 2023
b4d3c60
added color icons to /static/img
martyav Nov 2, 2023
3337789
Merge remote-tracking branch 'origin' into colored-icons-header
martyav Nov 2, 2023
f2dcce0
Add K8s Distro landing page content
btat Nov 2, 2023
faac2fe
added css + elemental icon
martyav Nov 2, 2023
2b961b5
rm'd temp file
martyav Nov 2, 2023
93f9643
Update src/css/custom.css
martyav Nov 3, 2023
cbb714d
rm usused icons
martyav Nov 3, 2023
5ddcc93
Merge pull request #975 from martyav/colored-icons-header
btat Nov 3, 2023
717152a
canonical links for single-user-nodes and user-settings
martyav Nov 3, 2023
4efd181
Update token setting page (#906)
JonCrowther Nov 3, 2023
19f5c68
Harvester landing page: apply feedback from #940
btat Nov 3, 2023
57be582
Rancher Desktop landing page: apply feedback from #944
btat Nov 3, 2023
1cf0508
Epinio landing page: apply feedback from #945
btat Nov 3, 2023
dacde1f
Merge pull request #972 from btat/k8s-distros-landing-page
btat Nov 3, 2023
a1a6875
Merge pull request #968 from btat/versions-table-2.7.9
btat Nov 3, 2023
01fd193
Merge pull request #976 from martyav/420-seo-single-node-and-user-set…
btat Nov 3, 2023
dec6fa4
Merge pull request #977 from btat/landing-page-feedback
btat Nov 3, 2023
f3dfd92
fixed spacing problem that ruined callout (#978)
martyav Nov 6, 2023
2dd001f
rm mention of Rio from 2.7 & 2.8 (#980)
martyav Nov 13, 2023
0719859
General FAQ copyedit (#983)
martyav Nov 14, 2023
b0435c7
Update etcd troubleshoot for etcd 3.5.7 and higher (#985)
superseb Nov 16, 2023
25771e2
Add session management section (#981)
pdellamore Nov 16, 2023
ccd59cb
#879 Add Project Owner to 'Project Member Can't Create Namespace' doc…
martyav Nov 16, 2023
6363363
135 cloud-provider(aws): Need to correct content on cluster id in aws…
martyav Nov 16, 2023
85fd70d
versioning
martyav Nov 16, 2023
b7f1b59
Add delete permission and remove duplicate header (#989)
btat Nov 17, 2023
631c5e4
Apply suggestions from code review
martyav Nov 17, 2023
42e2430
Amazon only uses EC2, so 'use anything' is a moot point
martyav Nov 17, 2023
de80752
Merge pull request #988 from martyav/135-cluster-id-aws-tagging
btat Nov 17, 2023
a49000e
Update CNI popularity chart numbers. Credit to @amitmavgupta for orig…
btat Nov 20, 2023
8faa4cc
Update Swagger file
btat Nov 20, 2023
3cd88f9
Fix etcd.backup_config.retention description
btat Nov 21, 2023
6fc757d
Add Projects API workflow example
btat Nov 21, 2023
f28cb43
Add project workflow to sidebar; remove duplicate API category
btat Nov 21, 2023
2ce446b
Merge pull request #992 from btat/cni-popularity
btat Nov 21, 2023
7115adb
Merge pull request #994 from btat/rke-retention-description
btat Nov 21, 2023
284b6dd
Update versioned_docs/version-2.8/api/workflows/projects.md
btat Nov 21, 2023
b9e971e
Merge pull request #993 from btat/swagger-file
btat Nov 21, 2023
b447e91
#963 clarify documentation for read only permissions in monitoring UI…
martyav Nov 22, 2023
e76ed17
Update versioned_docs/version-2.8/api/workflows/projects.md
btat Nov 22, 2023
f202e03
Merge pull request #998 from btat/projects-api
btat Nov 22, 2023
0b3fcee
Update migrate-rancher-to-new-cluster.md (#1007)
Nov 28, 2023
4b2f812
fix: update v2.7 cn sidebar
Nov 29, 2023
07c03a2
fixed typo in command (#1010)
martyav Nov 29, 2023
e4b5db6
Apply 4b2f8125 (sidebar label update) to other versions. Originally c…
btat Nov 29, 2023
5ae50af
Remove term from translated sidebar label to match English label
btat Nov 29, 2023
43df88d
Merge pull request #1009 from yzeng25/patch_cnsidebar
btat Nov 29, 2023
662afc6
#420 Completes canonical links task (#1011)
martyav Nov 30, 2023
5864196
Updating CSP Adapter versions
MbolotSuse Nov 30, 2023
1f39a6f
Merge pull request #1012 from MbolotSuse/csp-adapter-3.0.0
btat Nov 30, 2023
f175eae
embed video on aws marketplace page (#1016)
martyav Dec 6, 2023
03ea616
Port version-2.8 updates to latest (/docs) (#1013)
btat Dec 6, 2023
3d89188
#773: Add steps to install Rancher Extensions in an air-gapped enviro…
martyav Dec 6, 2023
79ac876
Add aws out of tree cloud provider install/upgrade docs (#844)
jakefhyde Dec 6, 2023
7ea840e
Add 2.8 entry to versions table (#1002)
btat Dec 6, 2023
3b8defd
Update webhook version table (#1006)
btat Dec 6, 2023
437ab19
correcting capitalization: helm > Helm (#1018)
martyav Dec 6, 2023
4c0aa9d
Remove preview label from 2.8
btat Dec 6, 2023
64e58f6
Merge pull request #1019 from btat/preview-label
btat Dec 6, 2023
7b30e7e
Remove unreleased banner
btat Dec 6, 2023
9bcdc44
Merge pull request #1021 from btat/28unreleased
btat Dec 6, 2023
e479cc3
rm 'add additional' phrase from docs (#1020)
martyav Dec 6, 2023
b482e74
rm deprecation banner from v2.8
martyav Dec 7, 2023
e9b3fe8
rm deprecation banner from v2.8 (#1023)
martyav Dec 7, 2023
e45997a
[skip ci] Update README to reflect current versioning model (#1022)
btat Dec 7, 2023
baef340
Merge branch 'main' of https://github.com/martyav/rancher-docs
martyav Dec 7, 2023
b2fdf75
Apply suggestions from code review
martyav Dec 8, 2023
988c090
Update create-a-vm-template.md
martyav Dec 8, 2023
49f2cf3
Update create-a-vm-template.md
lindhe Dec 8, 2023
b87d38e
Merge branch 'clarify-vsphere-dependencies' of https://github.com/lin…
martyav Dec 8, 2023
b368a24
versioning
martyav Dec 8, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ To get started, [fork](https://github.com/rancher/rancher-docs/fork) and clone t

Our repository doesn't allow you to make changes directly to the `main` branch. Create a working branch and make pull requests from your fork to [rancher/rancher-docs](https://github.com/rancher/rancher-docs).

For most updates, you'll need to edit a file in `/docs`, and the corresponding file in `/versioned_docs/version-2.7`. If a change affects older versions, you can find files documenting Rancher v2.0 and later in the `/versioned_docs` directory.
For most updates, you'll need to edit a file in the `/docs` directory, which represents the ["Latest"](https://ranchermanager.docs.rancher.com/) version of our published documentation. The "Latest" version is a mirror of the most recently released version of Rancher. As of December 2023, the most recently released version of Rancher is 2.8.

If a file is moved or renamed, you'll also need to edit the `sidebars.js` files for each version, and the list of redirects in `docusaurus.config.js`. See [Moving or Renaming Docs](./moving-or-renaming-docs.md).
Whenever an update is made to `/docs`, you should apply the same change to the corresponding file in `/versioned_docs/version-2.8`. If a change only affects older versions, you don't need to mirror it to the `/docs` directory.

If a file is moved or renamed, you'll also need to edit the `sidebars.js` files for each affected version, as well as the list of redirects in `docusaurus.config.js`. See [Moving or Renaming Docs](./moving-or-renaming-docs.md).

### Navigate the Repo

Expand Down
7 changes: 7 additions & 0 deletions docs/api/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: API Reference
---

import ApiDocMdx from '@theme/ApiDocMdx';

<ApiDocMdx id="rancher-api" />
140 changes: 140 additions & 0 deletions docs/api/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
---
title: API Quick Start Guide
---

You can access Rancher's resources through the Kubernetes API. This guide will help you get started on using this API as a Rancher user.

1. In the upper left corner, click **☰ > Global Settings**.
2. Find and copy the address in the `server-url` field.
3. [Create](../reference-guides/user-settings/api-keys#creating-an-api-key) a Rancher API key with no scope.

:::danger

A Rancher API key with no scope grants unrestricted access to all resources that the user can access. To prevent unauthorized use, this key should be stored securely and rotated frequently.

:::

4. Create a `kubeconfig.yaml` file. Replace `$SERVER_URL` with the server url and `$API_KEY` with your Rancher API key:

```yaml
apiVersion: v1
kind: Config
clusters:
- name: "rancher"
cluster:
server: "$SERVER_URL"

users:
- name: "rancher"
user:
token: "$API_KEY"

contexts:
- name: "rancher"
context:
user: "rancher"
cluster: "rancher"

current-context: "rancher"
```

You can use this file with any compatible tool, such as kubectl or [client-go](https://github.com/kubernetes/client-go). For a quick demo, see the [kubectl example](#api-kubectl-example).

For more information on handling more complex certificate setups, see [Specifying CA Certs](#specifying-ca-certs).

For more information on available kubeconfig options, see the [upstream documentation](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/).

## API kubectl Example

1. Set your KUBECONFIG environment variable to the kubeconfig file you just created:

```bash
export KUBECONFIG=$(pwd)/kubeconfig.yaml
```

2. Use `kubectl explain` to view the available fields for projects, or complex sub-fields of resources:

```bash
kubectl explain projects
kubectl explain projects.spec
```

Not all resources may have detailed output.

3. Add the following content to a file named `project.yaml`:

```yaml
apiVersion: management.cattle.io/v3
kind: Project
metadata:
# name should be unique across all projects in every cluster
name: p-abc123
# generateName can be used instead of `name` to randomly generate a name.
# generateName: p-
# namespace should match spec.ClusterName.
namespace: local
spec:
# clusterName should match `metadata.Name` of the target cluster.
clusterName: local
description: Example Project
# displayName is the human-readable name and is visible from the UI.
displayName: Example
```

4. Create the project:

```bash
kubectl create -f project.yaml
```

5. Delete the project:

How you delete the project depends on how you created the project name.

**A. If you used `name` when creating the project**:

```bash
kubectl delete -f project.yaml
```

**B. If you used `generateName`**:

Replace `$PROJECT_NAME` with the randomly generated name of the project displayed by Kubectl after you created the project.

```bash
kubectl delete project $PROJECT_NAME -n local
```

## Specifying CA Certs

To ensure that your tools can recognize Rancher's CA certificates, most setups require additional modifications to the above template.

1. In the upper left corner, click **☰ > Global Settings**.
2. Find and copy the value in the `ca-certs` field.
3. Save the value in a file named `rancher.crt`.

:::note
If your Rancher instance is proxied by another service, you must extract the certificate that the service is using, and add it to the kubeconfig file, as demonstrated in step 5.
:::

4. The following commands will convert `rancher.crt` to base64 output, trim all new-lines, and update the cluster in the kubeconfig with the certificate, then finishing by removing the `rancher.crt` file:

```bash
export KUBECONFIG=$PATH_TO_RANCHER_KUBECONFIG
kubectl config set clusters.rancher.certificate-authority-data $(cat rancher.crt | base64 -i - | tr -d '\n')
rm rancher.crt
```
5. (Optional) If you use self-signed certificatess that aren't trusted by your system, you can set the insecure option in your kubeconfig with kubectl:

:::danger

This option shouldn't be used in production as it is a security risk.

:::

```bash
export KUBECONFIG=$PATH_TO_RANCHER_KUBECONFIG
kubectl config set clusters.rancher.insecure-skip-tls-verify true
```

If your Rancher instance is proxied by another service, you must extract the certificate that the service is using, and add it to the kubeconfig file, as demonstrated above.
109 changes: 109 additions & 0 deletions docs/api/workflows/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
title: Projects
---

## Creating a Project

Project resources may only be created on the management cluster. See below for [creating namespaces under projects in a managed cluster](#creating-a-namespace-in-a-project).

### Creating a Basic Project

```bash
kubectl create -f - <<EOF
apiVersion: management.cattle.io/v3
kind: Project
metadata:
generateName: p-
namespace: c-m-abcde
spec:
clusterName: c-m-abcde
displayName: myproject
EOF
```

Use `metadata.generateName` to ensure a unique project ID, but note that `kubectl apply` does not work with `metadata.generateName`, so `kubectl create` must be used instead.

Set `metadata.namespace` and `spec.clusterName` to the ID for the cluster the project belongs to.

### Creating a Project With a Resource Quota

Refer to [Kubernetes Resource Quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/).

```bash
kubectl create -f - <<EOF
apiVersion: management.cattle.io/v3
kind: Project
metadata:
generateName: p-
namespace: c-m-abcde
spec:
clusterName: c-m-abcde
displayName: myproject
resourceQuota:
limit:
limitsCpu: 1000m
namespaceDefaultResourceQuota:
limit:
limitsCpu: 50m
EOF
```

### Creating a Project With Container Limit Ranges

Refer to [Kubernetes Limit Ranges](https://kubernetes.io/docs/concepts/policy/limit-range/).

```bash
kubectl create -f - <<EOF
apiVersion: management.cattle.io/v3
kind: Project
metadata:
generateName: p-
namespace: c-m-abcde
spec:
clusterName: c-m-abcde
displayName: myproject
containerDefaultResourceLimit:
limitsCpu: 100m
limitsMemory: 100Mi
requestsCpu: 50m
requestsMemory: 50Mi
```

## Creating a Namespace in a Project

The Project resource resides in the management cluster, even if the Project is for a managed cluster. The namespaces under the project reside in the managed cluster.

On the management cluster, look up the project ID for the cluster you are administrating since it generated using `metadata.generateName`:

```bash
kubectl --namespace c-m-abcde get projects
```

On the managed cluster, create a namespace with a project annotation:

```bash
kubectl apply -f - <<EOF
apiVersion: v1
kind: Namespace
metadata:
name: mynamespace
annotations:
field.cattle.io/projectId: c-m-abcde:p-vwxyz
EOF
```

Note the format, `<cluster ID>:<project ID>`.

## Deleting a Project

Look up the project to delete in the cluster namespace:

```bash
kubectl --namespace c-m-abcde get projects
```

Delete the project under the cluster namespace:

```bash
kubectl --namespace c-m-abcde delete project p-vwxyz
```
16 changes: 7 additions & 9 deletions docs/faq/container-network-interface-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,20 +182,18 @@ The following table summarizes the different features available for each CNI net

- Ingress/Egress Policies: This feature allows you to manage routing control for both Kubernetes and non-Kubernetes communications.


<!-- releaseTask -->
## CNI Community Popularity

The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity. This data was collected in January 2022.
The following table summarizes different GitHub metrics to give you an idea of each project's popularity and activity. This data was collected in November 2023.

| Provider | Project | Stars | Forks | Contributors |
| ---- | ---- | ---- | ---- | ---- |
| Canal | https://github.com/projectcalico/canal | 679 | 100 | 21 |
| Flannel | https://github.com/flannel-io/flannel | 7k | 2.5k | 185 |
| Calico | https://github.com/projectcalico/calico | 3.1k | 741 | 224 |
| Weave | https://github.com/weaveworks/weave/ | 6.2k | 635 | 84 |
| Cilium | https://github.com/cilium/cilium | 10.6k | 1.3k | 352 |

<br/>
| Canal | https://github.com/projectcalico/canal | 707 | 104 | 20 |
| Flannel | https://github.com/flannel-io/flannel | 8.3k | 2.9k | 225 |
| Calico | https://github.com/projectcalico/calico | 5.1k | 1.2k | 328 |
| Weave | https://github.com/weaveworks/weave/ | 6.5k | 672 | 87 |
| Cilium | https://github.com/cilium/cilium | 17.1k | 2.5k | 677 |

## Which CNI Provider Should I Use?

Expand Down
58 changes: 18 additions & 40 deletions docs/faq/general-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,68 +6,46 @@ title: General FAQ
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/faq/general-faq"/>
</head>

This FAQ is a work in progress designed to answers the questions our users most frequently ask about Rancher v2.x.
This FAQ is a work in progress designed to answer the questions most frequently asked about Rancher v2.x.

See [Technical FAQ](technical-items.md), for frequently asked technical questions.
See the [Technical FAQ](technical-items.md) for frequently asked technical questions.

<br/>
## Does Rancher v2.x support Docker Swarm and Mesos as environment types?

**Does Rancher v2.x support Docker Swarm and Mesos as environment types?**
Swarm and Mesos are no longer selectable options when you create a new environment in Rancher v2.x. However, both Swarm and Mesos will continue to be available as Catalog applications you can deploy. It was a tough decision to make but, in the end, it came down to adoption. For example, out of more than 15,000 clusters, only about 200 were running Swarm.

When creating an environment in Rancher v2.x, Swarm and Mesos will no longer be standard options you can select. However, both Swarm and Mesos will continue to be available as Catalog applications you can deploy. It was a tough decision to make but, in the end, it came down to adoption. For example, out of more than 15,000 clusters, only about 200 or so are running Swarm.
## Is it possible to manage Azure Kubernetes Services with Rancher v2.x?

<br/>
Yes. See our [Cluster Administration](../pages-for-subheaders/manage-clusters.md) guide for what Rancher features are available on AKS, as well as our [documentation on AKS](../getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rancher-on-aks.md).

**Is it possible to manage Azure Kubernetes Services with Rancher v2.x?**
## Does Rancher support Windows?

Yes.
Yes. Rancher supports Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.](../pages-for-subheaders/use-windows-clusters.md)

<br/>
## Does Rancher support Istio?

**Does Rancher support Windows?**
Yes. Rancher supports [Istio](../pages-for-subheaders/istio.md).

Rancher supports Windows Server 1809 containers. For details on how to set up a cluster with Windows worker nodes, refer to the section on [configuring custom clusters for Windows.](../pages-for-subheaders/use-windows-clusters.md)

<br/>

**Does Rancher support Istio?**

Rancher supports [Istio.](../pages-for-subheaders/istio.md)

Furthermore, Istio is implemented in our micro-PaaS "Rio", which works on Rancher 2.x along with any CNCF compliant Kubernetes cluster. You can read more about it [here](https://rio.io/)

<br/>

**Will Rancher v2.x support Hashicorp's Vault for storing secrets?**
## Will Rancher v2.x support Hashicorp's Vault for storing secrets?

Secrets management is on our roadmap but we haven't assigned it to a specific release yet.

<br/>

**Does Rancher v2.x support RKT containers as well?**
## Does Rancher v2.x support RKT containers as well?

At this time, we only support Docker.

<br/>

**Does Rancher v2.x support Calico, Contiv, Contrail, Flannel, Weave net, etc., for embedded and registered Kubernetes?**
## Does Rancher v2.x support Calico, Contiv, Contrail, Flannel, Weave net, etc., for embedded and registered Kubernetes?

Out-of-the-box, Rancher provides the following CNI network providers for Kubernetes clusters: Canal, Flannel, Calico and Weave. Always refer to the [Rancher Support Matrix](https://rancher.com/support-maintenance-terms/) for details about what is officially supported.

<br/>

**Are you planning on supporting Traefik for existing setups?**
## Are you planning on supporting Traefik for existing setups?

We don't currently plan on providing embedded Traefik support, but we're still exploring load-balancing approaches.

<br/>

**Can I import OpenShift Kubernetes clusters into v2.x?**

Our goal is to run any upstream Kubernetes clusters. Therefore, Rancher v2.x should work with OpenShift, but we haven't tested it yet.
## Can I import OpenShift Kubernetes clusters into v2.x?

<br/>
Our goal is to run any Kubernetes clusters. Therefore, Rancher v2.x should work with OpenShift, but we haven't tested it yet.

**Are you going to integrate Longhorn?**
## Is Longhorn integrated with Rancher?

Yes. Longhorn was integrated into Rancher v2.5+.
Yes. Longhorn is integrated with Rancher v2.5 and later.
Loading