Skip to content

Commit

Permalink
Merge pull request #3214 from zhuxiujuan28/docs
Browse files Browse the repository at this point in the history
【Documentation】 translate added docs
  • Loading branch information
ks-ci-bot authored Nov 8, 2024
2 parents ed1b50d + 8b34977 commit a53a977
Show file tree
Hide file tree
Showing 26 changed files with 1,413 additions and 120 deletions.
106 changes: 106 additions & 0 deletions content/en/docs/_custom-en/extension-intro-ks.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
[.admon.note,cols="a"]
|===
|Note

|You can get more information about each extension in the KubeSphere Marketplace on the {ks_product-en} web console.
|===

[%header,cols="1a,1a,3a"]
|===
|Category |Name |Function

.10+|WhizardTelemetry Observability Platform
|WhizardTelemetry Platform Service
|It is the common service for all observability extensions of WhizardTelemetry Observability Platform. It is a common APIServer that providing backend platform services for all observability extensions.

|WhizardTelemetry Data Pipeline
|Provides the ability to collect, transform, and route observability data.

|OpenSearch Distributed Search and Analytics Engine
|KubeSphere's built-in log storage extension, used to store, search and analyze observability data including logs, auditing events, K8s events, and notification history etc.

|WhizardTelemetry Logging
|Provides multi-tenant real-time and historical log collection, query, export, storage, etc., for cloud-native applications, and can connect to log receivers such as ElasticSearch, OpenSearch, Kafka, etc.

|WhizardTelemetry Events
|Stores events of Kubernetes resources and provides multi-tenant event query and viewing functions.

// |WhizardTelemetry Auditing
// |It provides auditing management for Kubernetes and KubeSphere: records user behaviors on the {ks_product-en} platform in real-time, and provides audit history query and viewing functions, which can quickly trace back the behaviors of users.

|WhizardTelemetry Monitoring
|Provides multi-tenant monitoring capabilities for cloud-native resources, including real-time and historical data display of core monitoring indicators for objects such as clusters, nodes, workloads, GPU, K8s control plane, etc. It includes the Whizard Observability Center.

|WhizardTelemetry Alerting
|Based on the monitoring data collected by KubeSphere, it manages alerting and alerting rules for different resource types and metrics data.

// |WhizardTelemetry Events Alerting
// |Define alerting rules for Kubernetes/KubeSphere auditing events, Kubernetes native events, and Kubernetes logs, evaluate incoming event data and log data, and send alerts to specified receivers such as HTTP endpoints.

|WhizardTelemetry Notification
|Manages notifications in multi-tenant Kubernetes environments. It receives alerts, cloud events, and other types of events (such as audits and Kubernetes events) from different senders, and send notifications to corresponding tenant receivers based on tenant labels (such as namespaces or users).

|Grafana for WhizardTelemetry
|An open and composable observability and data visualization platform, with many built-in dashboards to enhance the visualization capabilities of the WhizardTelemetry Observability Platform.

|Grafana Loki for WhizardTelemetry
|Supports viewing KubeSphere logs, audits, events, and notification history data stored in Loki on the Grafana console.

.6+|Platform Management
|KubeSphere App Store Management
|A multi-cloud application management platform based on OpenPitrix, used to upload, review, and manage different types of applications in multi-cloud environments. It can be used as a tool for sharing and distributing data, middleware, and office applications among different teams in the enterprise.

|KubeSphere Service Mesh
|A powerful microservice governance and microservice visualization management tool. It provides three grayscale release strategies including blue-green deployment, canary release, and traffic mirroring, and two observability capabilities including traffic monitoring and link tracing.

|KubeSphere Multi-Cluster Agent Connection
|It is a tool to establish network connections between clusters through the agent. If the host cluster cannot directly access the member clusters, you can expose the proxy service address of the host cluster, so that the member clusters can connect to the host cluster through the agent.

|Application Management for Cluster Federation
|An extension aimed at simplifying the management of applications across federated Kubernetes clusters. Users can easily deploy, update, and manage applications across multiple federated clusters.

|KubeEdge Edge Computing Framework
|Add edge nodes to the cluster and run workloads on these nodes to extend native containerized application orchestration and management to hosts at the Edge.

|Metrics Server
|Dynamically scale the number of pods based on metrics, allowing the services running on them to have a certain degree of self-adaptation to changes in metrics.

// |Spring Cloud
// |Provides microservices, microservice configuration, and microservice gateway functions.

// |Database and Middleware
// |RadonDB DMP
// |An enterprise-grade cloud-native database management platform for Kubernetes multi-cloud environments. It can easily achieve cross-cloud deployment, multi-cloud management, intelligent observation, and unified operation and maintenance of mainstream databases, and fully build an ecological closed loop around high performance, high availability, business tracking, data circulation, etc., helping customers truly realize database as a service.

|CI/CD
|DevOps
|Provides out-of-the-box CI/CD functions based on Jenkins, a one-stop DevOps solution, and supports creating pipelines using the graphical editing panel or Jenkinsfile.

.2+|Networking
|KubeSphere Gateway
|KubeSphere Gateway is an extension that aggregates services and manages external access to the KubeSphere platform. It has now formed a gateway system with three resource management dimensions: cluster, project, and workspace, supporting the management of cluster gateways, workspace gateways, and project gateways.

|KubeSphere Network
|Manages network policies and pod IP pools for the cluster. Controls access to and from pods in the cluster and projects; creates pod IP pools and allocates IP addresses to pods from the IP pool.

// |KubeSphere Ingress Utils
// |Provides multiple practical extension capabilities for ingress, such as Domain Reuse Validation. Once added, tenants cannot apply the same domain name to different projects when creating ingresses.

|Security
|Gatekeeper
|Gatekeeper is an admission controller for Kubernetes that allows flexible configuration of policies, using link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] to validate requests to create and update resources on Kubernetes clusters.

// |OAuth2-Proxy
// |Provides a unified authentication interface to ensure that all applications are protected through the same process, simplifying identity management in multi-application environments, enhancing application security and ease of access. It is suitable for enterprise environments that require unified authentication management for multiple backend applications, and applications that require user identity verification through third-party authentication services.

// |Cert Manager
// |Creates TLS certificates for workloads in Kubernetes and renews them before they expire.

|Storage
|KubeSphere Storage
|Manages volume snapshots, volume snapshot classes, sets authorization rules for storage classes, and sets automatic scaling of storage volumes.

// |AI
// |NVIDIA GPU Operator
// |An extension based on link:https://github.com/NVIDIA/gpu-operator[GPU Operator], supporting the creation, configuration, and management of GPUs on Kubernetes.
|===
38 changes: 38 additions & 0 deletions content/en/docs/_custom-en/install-all-extensions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
. Log in to the {ks_product-en} web console with a user having the **platform-admin** role.

. Click **Extensions Center** and search for you desired extension.

. Click the extension name and click **Install** to enter the installation process.

. On the **Version Selection** tab of the installation dialog, select the version number of the extension and install all required dependencies (if any). Then click **Next**.
+
[.admon.note,cols="a"]
|===
|Note

|
During the installation, it detects whether the extension has dependencies. Dependencies are categorized as required and optional.

If a required dependency is **Not Ready**, you need to install the required version first to ensure the normal use of the extension. Optional dependencies do not affect the installation of the extension.
|===

. On the **Extensions Installation** tab, make modifications to the configuration (if needed), and then click **Start Installation**.
+
image:/images/ks-qkcp/en/v4.0/install-extensions.png[,100%]

. After the installation is complete, click **Next** to configure the cluster agent.

. On the **Cluster Selection** tab, select clusters (multiple clusters can be selected) by name and identifier to enable extensions in the target clusters.

. On the **Diff Config** tab, edit the YAML configuration for the selected clusters separately, or leave it unchanged to use the default configuration. Click **OK** to start installing the cluster agent, and wait for it to complete.
+
--
After the installation is complete, extensions are enabled by default.

[.admon.note,cols="a"]
|===
|Note

|Some extensions do not require installing a cluster agent (i.e., there are no **Cluster Selection** and **Diff Config** tabs), so please refer to the actual page.
|===
--

This file was deleted.

42 changes: 42 additions & 0 deletions content/en/docs/v4.1/02-quickstart/02-install-an-extension.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "Install and Use Extensions"
keywords: "Kubernetes, KubeSphere, quick start, install extensions, example, DevOps, extension features"
description: "Introduce all extensions and demonstrate how to install them."
weight: 02
---


Starting from v4.1, KubeSphere decouples some functional components, which are seamlessly integrated into the KubeSphere web console as extensions and maintained independently, truly achieving a plug-and-play cloud-native operating system.

The original functional modules, such as DevOps, service mesh, observability (including monitoring, alerting, logging, events, notification), App Store, edge computing, network and storage management, are now provided by extensions. Therefore, to fully utilize these features, it is recommended that you select and install the extensions based on your actual needs, customizing your exclusive KubeSphere container management platform.


== Extensions Overview

Refer to the table below to understand the functions of extensions, so as to choose the appropriate extensions for installation.

include::../../_custom-en/extension-intro-ks.adoc[]

== Install Extensions

include::../../_custom-en/install-all-extensions.adoc[]

== Manage Extensions

ifeval::["{file_output_type}" == "html"]
You can link:../../06-extension-user-guide/03-manage-components[configure, update, disable, and uninstall extensions] in the Extensions Center.
endif::[]

ifeval::["{file_output_type}" == "pdf"]
You can configure, update, disable, and uninstall extensions in the Extensions Center. Please refer to the {ks_product-en} Extension Management Guide.
endif::[]

== Use Extensions

ifeval::["{file_output_type}" == "html"]
The usage methods of extensions vary. Please refer to the link:../../11-use-extensions/[Extension User Guide] to understand the entry, configuration, and usage methods of each extension.
endif::[]

ifeval::["{file_output_type}" == "pdf"]
The usage methods of extensions vary. Please refer to the {ks_product-en} Extension User Guide to get the entry, configuration, and usage methods of each extension.
endif::[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Create Workspaces, Projects, Users, and Platform Roles"
linkTitle: "Control User Permissions"
title: "Control User Permissions"
linkTitle: "Create Workspaces, Projects, Users, and Roles"
keywords: "Kubernetes, KubeSphere, Quick Start, User Permissions"
description: "Learn how to create users and control their permissions by roles in workspaces and projects."
weight: 03
Expand Down
Loading

0 comments on commit a53a977

Please sign in to comment.