Skip to content

Commit

Permalink
Update CSE 3.1.2 docs - rename TKG-I to TKGi, TKG-S to TKGs
Browse files Browse the repository at this point in the history 
Signed-off-by: rocknes <[email protected]>
  • Loading branch information
@rocknes
rocknes committed Feb 2, 2022
1 parent 4c0176f commit 797e6db
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 48 deletions.
4 changes: 2 additions & 2 deletions docs/cse3_1/CLUSTER_MANAGEMENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ Here is a summary of commands available to view templates and manage clusters an
<a name="cse31_cluster_share"></a>
### CSE 3.1 `Cluster share` command
The `vcd cse cluster share` command is supported for both TKG-S and native clusters.
- Sharing TKG-s clusters would simply share the corresponding RDEs with the other user(s).
The `vcd cse cluster share` command is supported for both TKGs and native clusters.
- Sharing TKGs clusters would simply share the corresponding RDEs with the other user(s).
- Sharing native clusters would share both the corresponding RDE and the backing vapp with the other user(s).

```sh
Expand Down
28 changes: 14 additions & 14 deletions docs/cse3_1/CSE31.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ For greenfield installations, please get started with [CSE introduction](INTRO.h
**Terminology:**
* TKG cluster : Clusters deployed by CSE using VMware Tanzu Kubernetes Grid OVA.
* Native cluster : Clusters deployed by CSE using upstream Kubernetes.
* TKG-S cluster : VMware Tanzu Kubernetes Grid Service cluster a.k.a vSphere with Tanzu cluster.
* TKG-I cluster : Enterprise PKS cluster a.k.a VMware Tanzu Kubernetes Grid Integrated Edition cluster.
* TKGs cluster : VMware Tanzu Kubernetes Grid Service cluster a.k.a vSphere with Tanzu cluster.
* TKGi cluster : Enterprise PKS cluster a.k.a VMware Tanzu Kubernetes Grid Integrated Edition cluster.
* Defined entities : Runtime defined entities a.k.a RDE or Defined Entity Framework.
* Native entities: Runtime defined entities representing Native clusters.
* TKG-S entities: Runtime defined entities representing TKG-S clusters.
* TKGs entities: Runtime defined entities representing TKGs clusters.
* Defined entity API: VCD's generic defined entity api to manage lifecycle of RDEs.
* UI plugin : Kubernetes Container Clusters UI plugin, that is used to manage Native, TKG, TKG-S, TKG-I clusters from VCD UI.
* UI plugin : Kubernetes Container Clusters UI plugin, that is used to manage Native, TKG, TKGs, TKGi clusters from VCD UI.

### CSE 3.1.2

Expand Down Expand Up @@ -55,7 +55,7 @@ For greenfield installations, please get started with [CSE introduction](INTRO.h
* Newer versions of native Kubernetes templates are available. Refer to
[Template announcements](TEMPLATE_ANNOUNCEMENTS.html)
* CSE 3.1 drops the support with VCD 10.0.
* **Deprecation of TKG-I (Enterprise PKS)** - CSE Server and Kubernetes Container Clusters plugin will soon drop support for TKG-I. Consider using VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKG-S) for management of Kubernetes clusters with VCD.
* **Deprecation of TKGi (Enterprise PKS)** - CSE Server and Kubernetes Container Clusters plugin will soon drop support for TKGi. Consider using VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKGs) for management of Kubernetes clusters with VCD.

## User Context Diagram

Expand Down Expand Up @@ -110,7 +110,7 @@ For greenfield installations, please get started with [CSE introduction](INTRO.h

**Note**: Ubuntu 20.04 Kubernetes OVAs from VMware Tanzu Kubernetes Grid Versions 1.4.0, 1.3.1, 1.3.0 are supported.

**TKG-S compatibility matrix**
**TKGs compatibility matrix**

| CSE CLI | UI plugin | Cloud Director |
|---------|------------|----------------|
Expand All @@ -122,13 +122,13 @@ For greenfield installations, please get started with [CSE introduction](INTRO.h
| 3.1.0 | 3.0.0 | 10.3.0 |
| 3.1.0 | 2.0.0 | 10.2.0 |

**Note** : TKG-S cluster management doesn't need CSE server to be running.
**Note** : TKGs cluster management doesn't need CSE server to be running.

**TKG-I compatibility matrix**
**TKGi compatibility matrix**

| CSE Server | Cloud Director | Ent-PKS | NSX-T |
|---------------------|----------------------|---------|-------|
| 3.1.2, 3.1.1, 3.1.0 | 10.3.1, 10.2.2, 10.1 | 1.7 | 2.5.1 |
| CSE Server | Cloud Director | TKGi | NSX-T |
|---------------------|----------------------|------|-------|
| 3.1.2, 3.1.1, 3.1.0 | 10.3.1, 10.2.2, 10.1 | 1.7 | 2.5.1 |

### 2.2 CSE Server

Expand Down Expand Up @@ -220,10 +220,10 @@ The provider needs to perform below operations to enable Kubernetes cluster
deployments in tenant organizations and tenant virtual data centers.
1. Grant rights to the tenant users. Refer to [CSE 3.1 RBAC](RBAC.html#rde_rbac)
for more details.
2. Enable the desired organization virtual datacenter(s) for Native, TKG-S, and/or TKG-I deployments.
2. Enable the desired organization virtual datacenter(s) for Native, TKGs, and/or TKGi deployments.
* Native clusters → [Enable VDC for Native clusters](TEMPLATE_MANAGEMENT.html#restrict_templates).
* TKG-S clusters → [Publish Kubernetes policy on VDC for TKG-S Clusters](https://docs.vmware.com/en/VMware-Cloud-Director/10.3/VMware-Cloud-Director-Service-Provider-Admin-Portal-Guide/GUID-E9839D4E-3024-445E-9D08-372113CF6FE0.html)
* TKG-I clusters → [Enable VDC for TKG-I clusters](ENT_PKS.html#cse-commands)
* TKGs clusters → [Publish Kubernetes policy on VDC for TKGs Clusters](https://docs.vmware.com/en/VMware-Cloud-Director/10.3/VMware-Cloud-Director-Service-Provider-Admin-Portal-Guide/GUID-E9839D4E-3024-445E-9D08-372113CF6FE0.html)
* TKGi clusters → [Enable VDC for TKGi clusters](ENT_PKS.html#cse-commands)
3. [Publish Kubernetes Container Clusters UI plugin](https://docs.vmware.com/en/VMware-Cloud-Director/10.3/VMware-Cloud-Director-Service-Provider-Admin-Portal-Guide/GUID-A1910FF9-B2CF-49DD-B031-D1245E8740AE.html)
to the desired organizations.

Expand Down
2 changes: 1 addition & 1 deletion docs/cse3_1/CSE_SERVER_MANAGEMENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,7 @@ vcd vdc use SAMPLE_VDC_NAME
# Enable organization vdc for Native
vcd cse ovdc enable SAMPLE_VDC_NAME

# Enable organization vdc for TKGI (Ent-PKS)
# Enable organization vdc for TKGi (Enterprise PKS)
vcd cse pks ovdc enable SAMPLE_VDC_NAME

```
14 changes: 7 additions & 7 deletions docs/cse3_1/ENT_PKS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ title: Enterprise PKS enablement
<span style="color:red">## Deprecation Notice</span>

CSE Server and Kubernetes Container Clusters plugin will soon drop support for
TKG-I (previously known as Enterprise PKS). Consider using
VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKG-S)
TKGi (previously known as Enterprise PKS). Consider using
VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKGs)
for management of Kubernetes clusters with VCD.

# Enterprise PKS enablement
Expand Down Expand Up @@ -116,7 +116,7 @@ CSE's default behavior i.e., all ovdc-s are open for native K8s cluster deployme
Do not choose Pay-as-you-go model for ovdc(s). Refer [FAQ](#faq) for more details.
2. Use these [CSE commands](#cse-commands) to grant K8 deployment rights to chosen tenants and tenant-users. Refer
[RBAC feature](RBAC.html) for more details
3. Use [CSE command](#cse-commands) to enable organization vdc(s) with a chosen K8-provider (native (or) ent-pks).
3. Use [CSE command](#cse-commands) to enable organization vdc(s) with a chosen K8-provider (native (or) TKGi).

Below diagram illustrates a time sequence view of setting up the infrastructure for CSE 2.0,
followed by the on boarding of tenants. The expected steps are executed by Cloud providers
Expand Down Expand Up @@ -171,15 +171,15 @@ Below steps of granting rights are required only if [RBAC feature](RBAC.html) is
* vcd user create 'power-user' 'password' 'Omni K8 Author'
```

**Enabling ovdc(s) for Ent-PKS deployments:**
Starting CSE 3.0, separate command group has been dedicated to Ent-PKS
**Enabling ovdc(s) for TKGi deployments:**
Starting CSE 3.0, separate command group has been dedicated to TKGi (Enterprise PKS)
```sh
* vcd cse pks ovdc list
* vcd cse pks ovdc enable ovdc2 -o tenant1 -k ent-pks --pks-plan "gold" --pks-cluster-domain "tenant1.com"
```

### Cluster management commands
Starting CSE 3.0, separate command group has been dedicated to Ent-PKS
Starting CSE 3.0, separate command group has been dedicated to TKGi (Enterprise PKS)
```sh
* vcd cse pks cluster list
* vcd cse pks cluster create
Expand Down Expand Up @@ -220,7 +220,7 @@ Starting CSE 3.0, separate command group has been dedicated to Ent-PKS
* Do Enterprise PKS based clusters adhere to its parent organization-vdc storage limits?
* This functionality is not available yet. As of today, organization-vdc storage limits apply
only for native K8 clusters.
* Can native K8 clusters be deployed in organization-vdc(s) dedicated for Ent-PKS?
* Can native K8 clusters be deployed in organization-vdc(s) dedicated for TKGi?
* This functionality is not available yet.
* Can tenant get a dedicated storage for their Enterprise PKS based clusters?
* This functionality is not available yet.
Expand Down
16 changes: 8 additions & 8 deletions docs/cse3_1/RBAC.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Role Based Access Control

CSE 3.1, when connected to either VCD 10.3 (or) VCD 10.2, leverages the RBAC that comes with VCD's feature
[Defined Entity framework](https://docs.vmware.com/en/VMware-Cloud-Director/10.2/VMware-Cloud-Director-Service-Provider-Admin-Portal-Guide/GUID-0749DEA0-08A2-4F32-BDD7-D16869578F96.html)
for Native, TKG and TKG-S clusters. RBAC for [TKG-I clusters](#old RBAC) remain as-is.
for Native, TKG and TKGs clusters. RBAC for [TKGi clusters](#old RBAC) remain as-is.

Note: The RBAC in this section refers to the roles and rights required for the tenants
to perform the life cycle management of kubernetes clusters. It does not have
Expand All @@ -23,18 +23,18 @@ representation for native clusters, a new right bundle `cse:nativeCluster entitl
gets created in VMware Cloud Director (VCD) during CSE server installation, which is what
guards the native cluster operations in CSE >= 3.0. Since TKG clusters reuse the
native RDE for its representation, access to life cycle management of TKG clusters
is also guarded by the same rights as native clusters. TKG-S clusters are guarded by
is also guarded by the same rights as native clusters. TKGs clusters are guarded by
a separate set of rights that comes pre-installed with VCD.

* Right bundle for Native cluster → `cse:nativeCluster entitlement`
* Right bundle for TKG cluster → `cse:nativeCluster entitlement`
* Right bundle for TKG-S Cluster → `vmware:tkgcluster entitlement`
* Right bundle for TKGs Cluster → `vmware:tkgcluster entitlement`

Five rights exist in each of the above right bundles. Note that any custom
role created with these rights need to have at least the privileges
of the pre-defined role `vApp Author` in order to deploy native/TKG/TKG-S clusters.
of the pre-defined role `vApp Author` in order to deploy native/TKG/TKGs clusters.

The Provider needs to grant the Native and/or TKG-S right bundles
The Provider needs to grant the Native and/or TKGs right bundles
to the desired organizations and then grant the admin-level defined entity type
rights to the `Tenant Administrator` role. This will enable the tenant administrator
to further assign the relevant cluster management rights to the desired tenant users.
Expand Down Expand Up @@ -82,9 +82,9 @@ the restricted operations.
| cluster resize | Native(VCD) | {cse}:CSE NATIVE DEPLOY RIGHT | CSE 1.2.6 |
| node create | Native(VCD) | {cse}:CSE NATIVE DEPLOY RIGHT | CSE 1.2.6 |
| node delete | Native(VCD) | {cse}:CSE NATIVE DEPLOY RIGHT | CSE 1.2.6 |
| cluster create | TKG-I | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |
| cluster delete | TKG-I | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |
| cluster resize | TKG-I | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |
| cluster create | TKGi | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |
| cluster delete | TKGi | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |
| cluster resize | TKGi | {cse}:PKS DEPLOY RIGHT | CSE 2.0.0b1 |

Note: Role Based Access Control feature is turned off by default.

Expand Down
32 changes: 16 additions & 16 deletions docs/cse3_1/RELEASE_NOTES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Release Notes
# General Announcement
**Date : 2022-01-27**
* Container Service Extension 3.1.x reaches end of support on July 15, 2023.
* Tanzu Kubernetes Grid Integrated Edition (TKG-I) reaches end of support on Feb 24, 2022.
* Tanzu Kubernetes Grid Integrated Edition (TKGi) integration with CSE reaches end of support on Feb 24, 2022.

**Date : 2021-12-15**
CSE is not impacted by the Apache Log4j open source component vulnerability.
Expand Down Expand Up @@ -191,34 +191,34 @@ they won't be tested individually. If a bug is found in their interoperability
with CSE, please file a github [issue](https://github.com/vmware/container-service-extension/issues),
the same will be fixed in a future CSE release.

| CSE Server | CSE CLI | CSE UI | Cloud Director | Ent-PKS with NSX-T | NSX-V | Features offered |
|------------|---------|--------|----------------|--------------------|--------|-----------------------------------------------------------------------------------------------------|
| 3.1 | 3.1 | 3.0* | 10.3 | 1.7 with 2.5.1 | 6.4.10 | Native, TKG-S, and Ent-PKS Cluster management; |
| 3.1 | 3.1 | 2.0* | 10.2 | 1.7 with 2.5.1 | 6.4.10 | Native, TKG-S, and Ent-PKS Cluster management; Defined entity representation for both native and tkg. |
| 3.1 | 3.1 | 1.0.3 | 10.1 | 1.7 with 2.5.1 | 6.4.8 | Native and Ent-PKS cluster management |
| NA | 3.1 | 3.0* | 10.3 | NA | NA | TKG-S cluster management only |
| NA | 3.1 | 2.0* | 10.2 | NA | NA | TKG-S cluster management only |
| CSE Server | CSE CLI | CSE UI | Cloud Director | TKGi with NSX-T | NSX-V | Features offered |
|------------|---------|--------|----------------|-----------------|--------|---------------------------------------------------------------------------------------------------|
| 3.1 | 3.1 | 3.0* | 10.3 | 1.7 with 2.5.1 | 6.4.10 | Native, TKGs, and TKGi Cluster management; |
| 3.1 | 3.1 | 2.0* | 10.2 | 1.7 with 2.5.1 | 6.4.10 | Native, TKGs, and TKGi Cluster management; Defined entity representation for both native and TKG. |
| 3.1 | 3.1 | 1.0.3 | 10.1 | 1.7 with 2.5.1 | 6.4.8 | Native and TKGi cluster management |
| NA | 3.1 | 3.0* | 10.3 | NA | NA | TKGs cluster management only |
| NA | 3.1 | 2.0* | 10.2 | NA | NA | TKGs cluster management only |

3.0*, 2.0* -> Kubernetes Container Clusters UI plugin 3.0 and 2.0 ship with VCD 10.3 and VCD 10.2 respectively.

1. Refer to [What's new in CSE 3.1?](CSE31.html) for more details.
2. Newer versions of native kubernetes templates are available. Refer to
[Template Announcements](TEMPLATE_ANNOUNCEMENTS.html)
1. Deprecation of TKG-I (Enterprise PKS) - CSE Server and Kubernetes Container Clusters UI plugin
will soon drop support for TKG-I (previously known as Enterprise PKS). Consider using
VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKG-S) for
1. Deprecation of TKGi (Enterprise PKS) - CSE Server and Kubernetes Container Clusters UI plugin
will soon drop support for TKGi (previously known as Enterprise PKS). Consider using
VMware Tanzu Kubernetes Grid (TKG) or VMware Tanzu Kubernetes Grid Service (TKGs) for
management of Kubernetes clusters with VCD.

## CSE 3.1.0 Beta (3.1.0.0b1)
Release Date: 2021-04-14

Supported VCD versions: 10.3.0-Beta, 10.2.2, 10.1.3, 10.0.0.3

| CSE Server | CSE CLI | CSE UI | Cloud Director | Cloud Director NSX-T | Ent-PKS with NSX-T | Features offered |
|------------|---------|---------|----------------------|----------------------|--------------------|-----------------------------------------------------------------------------------------------------|
| 3.1.0 | 3.1.0 | 3.0.2** | 10.3.0-beta, 10.2.2 | 3.0.2, 3.1.2 | 1.7 with 2.5.1 | Native, Tkg, and Ent-PKS Cluster management; Defined entity representation for both native and tkg. |
| 3.1.0 | 3.1.0 | 1.0.3 | 10.1, 10.0 | NA | 1.7 with 2.5.1 | Native and Ent-PKS cluster management |
| NA | 3.1.0 | 3.0.2** | 10.3.0-beta, 10.2.2 | NA | NA | Tkg cluster management only |
| CSE Server | CSE CLI | CSE UI | Cloud Director | Cloud Director NSX-T | TKGi with NSX-T | Features offered |
|------------|---------|---------|----------------------|----------------------|-----------------|---------------------------------------------------------------------------------------------------|
| 3.1.0 | 3.1.0 | 3.0.2** | 10.3.0-beta, 10.2.2 | 3.0.2, 3.1.2 | 1.7 with 2.5.1 | Native, TKGs, and TKGi Cluster management; Defined entity representation for both native and TKG. |
| 3.1.0 | 3.1.0 | 1.0.3 | 10.1, 10.0 | NA | 1.7 with 2.5.1 | Native and TKGi cluster management |
| NA | 3.1.0 | 3.0.2** | 10.3.0-beta, 10.2.2 | NA | NA | TKGs cluster management only |


**Installation of binaries**
Expand Down

0 comments on commit 797e6db

Please sign in to comment.