From fb049d0f22506c1e72a46277cf5cdd23d0061633 Mon Sep 17 00:00:00 2001 From: Bettygogo2021 <91529409+Bettygogo2021@users.noreply.github.com> Date: Wed, 17 Aug 2022 16:15:50 +0800 Subject: [PATCH] fix 3.3 cc file Signed-off-by: Bettygogo2021 <91529409+Bettygogo2021@users.noreply.github.com> --- .../log-collections/introduction.md | 2 +- .../en/docs/v3.3/faq/observability/logging.md | 22 +- .../install-kubesphere-on-vmware-vsphere.md | 224 +++++++++++++----- .../pluggable-components/auditing-logs.md | 12 +- .../docs/v3.3/pluggable-components/events.md | 12 +- .../v3.3/pluggable-components/kubeedge.md | 92 +++---- .../docs/v3.3/pluggable-components/logging.md | 27 +-- .../project-network-isolation.md | 2 +- .../application-workloads/routes.md | 14 +- .../log-collections/introduction.md | 2 +- .../zh/docs/v3.3/faq/observability/logging.md | 18 +- .../install-kubesphere-on-huaweicloud-ecs.md | 186 ++++++++++----- .../pluggable-components/auditing-logs.md | 12 +- .../docs/v3.3/pluggable-components/events.md | 12 +- .../v3.3/pluggable-components/kubeedge.md | 92 +++---- .../docs/v3.3/pluggable-components/logging.md | 27 +-- .../application-workloads/routes.md | 15 +- 17 files changed, 467 insertions(+), 304 deletions(-) diff --git a/content/en/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md b/content/en/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md index fff871c1b..8651b2f6f 100644 --- a/content/en/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md +++ b/content/en/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md @@ -45,7 +45,7 @@ To add a log receiver: A default Elasticsearch receiver will be added with its service address set to an Elasticsearch cluster if `logging`, `events`, or `auditing` is enabled in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md). -An internal Elasticsearch cluster will be deployed to the Kubernetes cluster if neither `externalElasticsearchUrl` nor `externalElasticsearchPort` is specified in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md) when `logging`, `events`, or `auditing` is enabled. The internal Elasticsearch cluster is for testing and development only. It is recommended that you configure an external Elasticsearch cluster for production. +An internal Elasticsearch cluster will be deployed to the Kubernetes cluster if neither `externalElasticsearchHost` nor `externalElasticsearchPort` is specified in [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md) when `logging`, `events`, or `auditing` is enabled. The internal Elasticsearch cluster is for testing and development only. It is recommended that you configure an external Elasticsearch cluster for production. Log searching relies on the internal or external Elasticsearch cluster configured. diff --git a/content/en/docs/v3.3/faq/observability/logging.md b/content/en/docs/v3.3/faq/observability/logging.md index 45809971b..3d0df57c9 100644 --- a/content/en/docs/v3.3/faq/observability/logging.md +++ b/content/en/docs/v3.3/faq/observability/logging.md @@ -19,7 +19,7 @@ This page contains some of the frequently asked questions about logging. ## How to change the log store to the external Elasticsearch and shut down the internal Elasticsearch -If you are using the KubeSphere internal Elasticsearch and want to change it to your external alternate, follow the steps below. If you haven't enabled the logging system, refer to [KubeSphere Logging System](../../../pluggable-components/logging/) to setup your external Elasticsearch directly. +If you are using the KubeSphere internal Elasticsearch and want to change it to your external alternate, follow the steps below. If you haven't enabled the logging system, refer to [KubeSphere Logging System](../../../pluggable-components/logging/) to set up your external Elasticsearch directly. 1. First, you need to update the KubeKey configuration. Execute the following command: @@ -27,7 +27,7 @@ If you are using the KubeSphere internal Elasticsearch and want to change it to kubectl edit cc -n kubesphere-system ks-installer ``` -2. Comment out `es.elasticsearchDataXXX`, `es.elasticsearchMasterXXX` and `status.logging`, and set `es.externalElasticsearchUrl` to the address of your Elasticsearch and `es.externalElasticsearchPort` to its port number. Below is an example for your reference. +2. Comment out `es.elasticsearchDataXXX`, `es.elasticsearchMasterXXX` and `status.logging`, and set `es.externalElasticsearchHost` to the address of your Elasticsearch and `es.externalElasticsearchPort` to its port number. Below is an example for your reference. ```yaml apiVersion: installer.kubesphere.io/v1alpha1 @@ -39,14 +39,18 @@ If you are using the KubeSphere internal Elasticsearch and want to change it to spec: ... common: - es: - # elasticsearchDataReplicas: 1 - # elasticsearchDataVolumeSize: 20Gi - # elasticsearchMasterReplicas: 1 - # elasticsearchMasterVolumeSize: 4Gi + es: # Storage backend for logging, events and auditing. + # master: + # volumeSize: 4Gi # The volume size of Elasticsearch master nodes. + # replicas: 1 # The total number of master nodes. Even numbers are not allowed. + # resources: {} + # data: + # volumeSize: 20Gi # The volume size of Elasticsearch data nodes. + # replicas: 1 # The total number of data nodes. + # resources: {} elkPrefix: logstash logMaxAge: 7 - externalElasticsearchUrl: <192.168.0.2> + externalElasticsearchHost: <192.168.0.2> externalElasticsearchPort: <9200> ... status: @@ -122,7 +126,7 @@ Perform the following to update the KubeKey configurations. If you have not set the retention period of events, auditing logs, and Istio logs, the value of `logMaxAge` is used by default. {{}} -3. In the YAML file, detete the `es` parameter, save the changes, and ks-installer will automatically restart to make the changes take effective. +3. In the YAML file, delete the `es` parameter, save the changes, and ks-installer will automatically restart to make the changes take effective. ```yaml apiVersion: installer.kubesphere.io/v1alpha1 diff --git a/content/en/docs/v3.3/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md b/content/en/docs/v3.3/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md index 45f89a35f..ac9d0016f 100644 --- a/content/en/docs/v3.3/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md +++ b/content/en/docs/v3.3/installing-on-linux/on-premises/install-kubesphere-on-vmware-vsphere.md @@ -422,6 +422,8 @@ spec: localVolume: storageClassName: local +--- +--- --- apiVersion: installer.kubesphere.io/v1alpha1 kind: ClusterConfiguration @@ -431,68 +433,182 @@ metadata: labels: version: v3.3.0 spec: - local_registry: "" persistence: - storageClass: "" + storageClass: "" # If there is no default StorageClass in your cluster, you need to specify an existing StorageClass here. authentication: - jwtSecret: "" + jwtSecret: "" # Keep the jwtSecret consistent with the Host Cluster. Retrieve the jwtSecret by executing "kubectl -n kubesphere-system get cm kubesphere-config -o yaml | grep -v "apiVersion" | grep jwtSecret" on the Host Cluster. + local_registry: "" # Add your private registry address if it is needed. + # dev_tag: "" # Add your kubesphere image tag you want to install, by default it's same as ks-installer release version. etcd: - monitoring: true # Whether to install etcd monitoring dashboard - endpointIps: 192.168.0.7,192.168.0.8,192.168.0.9 # etcd cluster endpointIps - port: 2379 # etcd port + monitoring: false # Enable or disable etcd monitoring dashboard installation. You have to create a Secret for etcd before you enable it. + endpointIps: localhost # etcd cluster EndpointIps. It can be a bunch of IPs here. + port: 2379 # etcd port. tlsEnable: true common: - mysqlVolumeSize: 20Gi # MySQL PVC size - minioVolumeSize: 20Gi # Minio PVC size - etcdVolumeSize: 20Gi # etcd PVC size - openldapVolumeSize: 2Gi # openldap PVC size - redisVolumSize: 2Gi # Redis PVC size - es: # Storage backend for logging, tracing, events and auditing. - elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number - elasticsearchDataReplicas: 1 # total number of data nodes - elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes - elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes - logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default. - elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log - # externalElasticsearchUrl: - # externalElasticsearchPort: - console: - enableMultiLogin: false # enable/disable multiple sing on, it allows a user can be used by different users at the same time. - port: 30880 - alerting: # Whether to install KubeSphere alerting system. It enables Users to customize alerting policies to send messages to receivers in time with different time intervals and alerting levels to choose from. - enabled: false - auditing: # Whether to install KubeSphere audit log system. It provides a security-relevant chronological set of records，recording the sequence of activities happened in platform, initiated by different tenants. - enabled: false - devops: # Whether to install KubeSphere DevOps System. It provides out-of-box CI/CD system based on Jenkins, and automated workflow tools including Source-to-Image & Binary-to-Image - enabled: false - jenkinsMemoryLim: 2Gi # Jenkins memory limit - jenkinsMemoryReq: 1500Mi # Jenkins memory request - jenkinsVolumeSize: 8Gi # Jenkins volume size - jenkinsJavaOpts_Xms: 512m # The following three fields are JVM parameters - jenkinsJavaOpts_Xmx: 512m + core: + console: + enableMultiLogin: true # Enable or disable simultaneous logins. It allows different users to log in with the same account at the same time. + port: 30880 + type: NodePort + # apiserver: # Enlarge the apiserver and controller manager's resource requests and limits for the large cluster + # resources: {} + # controllerManager: + # resources: {} + redis: + enabled: false + enableHA: false + volumeSize: 2Gi # Redis PVC size. + openldap: + enabled: false + volumeSize: 2Gi # openldap PVC size. + minio: + volumeSize: 20Gi # Minio PVC size. + monitoring: + # type: external # Whether to specify the external prometheus stack, and need to modify the endpoint at the next line. + endpoint: http://prometheus-operated.kubesphere-monitoring-system.svc:9090 # Prometheus endpoint to get metrics data. + GPUMonitoring: # Enable or disable the GPU-related metrics. If you enable this switch but have no GPU resources, Kubesphere will set it to zero. + enabled: false + gpu: # Install GPUKinds. The default GPU kind is nvidia.com/gpu. Other GPU kinds can be added here according to your needs. + kinds: + - resourceName: "nvidia.com/gpu" + resourceType: "GPU" + default: true + es: # Storage backend for logging, events and auditing. + # master: + # volumeSize: 4Gi # The volume size of Elasticsearch master nodes. + # replicas: 1 # The total number of master nodes. Even numbers are not allowed. + # resources: {} + # data: + # volumeSize: 20Gi # The volume size of Elasticsearch data nodes. + # replicas: 1 # The total number of data nodes. + # resources: {} + logMaxAge: 7 # Log retention time in built-in Elasticsearch. It is 7 days by default. + elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. + basicAuth: + enabled: false + username: "" + password: "" + externalElasticsearchHost: "" + externalElasticsearchPort: "" + alerting: # (CPU: 0.1 Core, Memory: 100 MiB) It enables users to customize alerting policies to send messages to receivers in time with different time intervals and alerting levels to choose from. + enabled: false # Enable or disable the KubeSphere Alerting System. + # thanosruler: + # replicas: 1 + # resources: {} + auditing: # Provide a security-relevant chronological set of records，recording the sequence of activities happening on the platform, initiated by different tenants. + enabled: false # Enable or disable the KubeSphere Auditing Log System. + # operator: + # resources: {} + # webhook: + # resources: {} + devops: # (CPU: 0.47 Core, Memory: 8.6 G) Provide an out-of-the-box CI/CD system based on Jenkins, and automated workflow tools including Source-to-Image & Binary-to-Image. + enabled: false # Enable or disable the KubeSphere DevOps System. + # resources: {} + jenkinsMemoryLim: 2Gi # Jenkins memory limit. + jenkinsMemoryReq: 1500Mi # Jenkins memory request. + jenkinsVolumeSize: 8Gi # Jenkins volume size. + jenkinsJavaOpts_Xms: 1200m # The following three fields are JVM parameters. + jenkinsJavaOpts_Xmx: 1600m jenkinsJavaOpts_MaxRAM: 2g - events: # Whether to install KubeSphere events system. It provides a graphical web console for Kubernetes Events exporting, filtering and alerting in multi-tenant Kubernetes clusters. - enabled: false - logging: # Whether to install KubeSphere logging system. Flexible logging functions are provided for log query, collection and management in a unified console. Additional log collectors can be added, such as Elasticsearch, Kafka and Fluentd. - enabled: false - logsidecarReplicas: 2 - metrics_server: # Whether to install metrics-server. IT enables HPA (Horizontal Pod Autoscaler). - enabled: true - monitoring: # - prometheusReplicas: 1 # Prometheus replicas are responsible for monitoring different segments of data source and provide high availability as well. - prometheusMemoryRequest: 400Mi # Prometheus request memory - prometheusVolumeSize: 20Gi # Prometheus PVC size - alertmanagerReplicas: 1 # AlertManager Replicas + events: # Provide a graphical web console for Kubernetes Events exporting, filtering and alerting in multi-tenant Kubernetes clusters. + enabled: false # Enable or disable the KubeSphere Events System. + # operator: + # resources: {} + # exporter: + # resources: {} + # ruler: + # enabled: true + # replicas: 2 + # resources: {} + logging: # (CPU: 57 m, Memory: 2.76 G) Flexible logging functions are provided for log query, collection and management in a unified console. Additional log collectors can be added, such as Elasticsearch, Kafka and Fluentd. + enabled: false # Enable or disable the KubeSphere Logging System. + logsidecar: + enabled: true + replicas: 2 + # resources: {} + metrics_server: # (CPU: 56 m, Memory: 44.35 MiB) It enables HPA (Horizontal Pod Autoscaler). + enabled: false # Enable or disable metrics-server. + monitoring: + storageClass: "" # If there is an independent StorageClass you need for Prometheus, you can specify it here. The default StorageClass is used by default. + node_exporter: + port: 9100 + # resources: {} + # kube_rbac_proxy: + # resources: {} + # kube_state_metrics: + # resources: {} + # prometheus: + # replicas: 1 # Prometheus replicas are responsible for monitoring different segments of data source and providing high availability. + # volumeSize: 20Gi # Prometheus PVC size. + # resources: {} + # operator: + # resources: {} + # alertmanager: + # replicas: 1 # AlertManager Replicas. + # resources: {} + # notification_manager: + # resources: {} + # operator: + # resources: {} + # proxy: + # resources: {} + gpu: # GPU monitoring-related plug-in installation. + nvidia_dcgm_exporter: # Ensure that gpu resources on your hosts can be used normally, otherwise this plug-in will not work properly. + enabled: false # Check whether the labels on the GPU hosts contain "nvidia.com/gpu.present=true" to ensure that the DCGM pod is scheduled to these nodes. + # resources: {} multicluster: - clusterRole: none # host | member | none # You can install a solo cluster, or specify it as the role of host or member cluster - networkpolicy: # Network policies allow network isolation within the same cluster, which means firewalls can be set up between certain instances (Pods). - enabled: false - notification: # It supports notification management in multi-tenant Kubernetes clusters. It allows you to set AlertManager as its sender, and receivers include Email, Wechat Work, and Slack. - enabled: false - openpitrix: # Whether to install KubeSphere App Store. It provides an application store for Helm-based applications, and offer application lifecycle management - enabled: false - servicemesh: # (0.3 Core, 300 MiB) Provide fine-grained traffic management, observability and tracing, and visualized traffic topology + clusterRole: none # host | member | none # You can install a solo cluster, or specify it as the Host or Member Cluster. + network: + networkpolicy: # Network policies allow network isolation within the same cluster, which means firewalls can be set up between certain instances (Pods). + # Make sure that the CNI network plugin used by the cluster supports NetworkPolicy. There are a number of CNI network plugins that support NetworkPolicy, including Calico, Cilium, Kube-router, Romana and Weave Net. + enabled: false # Enable or disable network policies. + ippool: # Use Pod IP Pools to manage the Pod network address space. Pods to be created can be assigned IP addresses from a Pod IP Pool. + type: none # Specify "calico" for this field if Calico is used as your CNI plugin. "none" means that Pod IP Pools are disabled. + topology: # Use Service Topology to view Service-to-Service communication based on Weave Scope. + type: none # Specify "weave-scope" for this field to enable Service Topology. "none" means that Service Topology is disabled. + openpitrix: # An App Store that is accessible to all platform tenants. You can use it to manage apps across their entire lifecycle. + store: + enabled: false # Enable or disable the KubeSphere App Store. + servicemesh: # (0.3 Core, 300 MiB) Provide fine-grained traffic management, observability and tracing, and visualized traffic topology. + enabled: false # Base component (pilot). Enable or disable KubeSphere Service Mesh (Istio-based). + istio: # Customizing the istio installation configuration, refer to https://istio.io/latest/docs/setup/additional-setup/customize-installation/ + components: + ingressGateways: + - name: istio-ingressgateway + enabled: false + cni: + enabled: false + edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false + iptables-manager: + enabled: true + mode: "external" + # resources: {} + # edgeService: + # resources: {} + gatekeeper: # Provide admission policy and rule management, A validating (mutating TBA) webhook that enforces CRD-based policies executed by Open Policy Agent. + enabled: false # Enable or disable Gatekeeper. + # controller_manager: + # resources: {} + # audit: + # resources: {} + terminal: + # image: 'alpine:3.15' # There must be an nsenter program in the image + timeout: 600 # Container timeout, if set to 0, no timeout will be used. The unit is seconds ``` Create a cluster using the configuration file you customized above: diff --git a/content/en/docs/v3.3/pluggable-components/auditing-logs.md b/content/en/docs/v3.3/pluggable-components/auditing-logs.md index af0518438..22aaeccf3 100644 --- a/content/en/docs/v3.3/pluggable-components/auditing-logs.md +++ b/content/en/docs/v3.3/pluggable-components/auditing-logs.md @@ -34,7 +34,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ``` {{< notice note >}} -By default, KubeKey will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Auditing, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. +By default, KubeKey will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Auditing, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -45,7 +45,7 @@ By default, KubeKey will install Elasticsearch internally if Auditing is enabled elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -73,7 +73,7 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu ``` {{< notice note >}} -By default, ks-installer will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Auditing, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. +By default, ks-installer will install Elasticsearch internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Auditing, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -84,7 +84,7 @@ By default, ks-installer will install Elasticsearch internally if Auditing is en elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -116,7 +116,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ``` {{< notice note >}} -By default, Elasticsearch will be installed internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Auditing, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. +By default, Elasticsearch will be installed internally if Auditing is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Auditing, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -127,7 +127,7 @@ By default, Elasticsearch will be installed internally if Auditing is enabled. F elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/en/docs/v3.3/pluggable-components/events.md b/content/en/docs/v3.3/pluggable-components/events.md index d3ce3caa5..989e6f1f9 100644 --- a/content/en/docs/v3.3/pluggable-components/events.md +++ b/content/en/docs/v3.3/pluggable-components/events.md @@ -36,7 +36,7 @@ If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), ``` {{< notice note >}} -By default, KubeKey will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. +By default, KubeKey will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Events, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -47,7 +47,7 @@ By default, KubeKey will install Elasticsearch internally if Events is enabled. elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -75,7 +75,7 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu ``` {{< notice note >}} -By default, ks-installer will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. +By default, ks-installer will install Elasticsearch internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Events, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -86,7 +86,7 @@ By default, ks-installer will install Elasticsearch internally if Events is enab elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -121,7 +121,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource {{< notice note >}} -By default, Elasticsearch will be installed internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Events, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. +By default, Elasticsearch will be installed internally if Events is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Events, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -132,7 +132,7 @@ By default, Elasticsearch will be installed internally if Events is enabled. For elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/en/docs/v3.3/pluggable-components/kubeedge.md b/content/en/docs/v3.3/pluggable-components/kubeedge.md index 7cdd0c85f..3df754190 100644 --- a/content/en/docs/v3.3/pluggable-components/kubeedge.md +++ b/content/en/docs/v3.3/pluggable-components/kubeedge.md @@ -34,21 +34,21 @@ When you implement multi-node installation of KubeSphere on Linux, you need to c ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false ``` 3. Set the value of `kubeedge.cloudCore.cloudHub.advertiseAddress` to the public IP address of your cluster or an IP address that can be accessed by edge nodes. Save the file when you finish editing. @@ -71,24 +71,24 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu 2. In this local `cluster-configuration.yaml` file, navigate to `edgeruntime` and `kubeedge`, and change the value of `enabled` from `false` to `true` to enable all KubeEdge components. Click **OK**. - ```yaml + ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false - ``` + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false + ``` 3. Set the value of `kubeedge.cloudCore.cloudHub.advertiseAddress` to the public IP address of your cluster or an IP address that can be accessed by edge nodes. @@ -114,24 +114,24 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource 4. In this YAML file, navigate to `edgeruntime` and `kubeedge`, and change the value of `enabled` from `false` to `true` to enable all KubeEdge components. Click **OK**. - ```yaml + ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false - ``` + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false + ``` 5. Set the value of `kubeedge.cloudCore.cloudHub.advertiseAddress` to the public IP address of your cluster or an IP address that can be accessed by edge nodes. After you finish, click **OK** in the lower-right corner to save the configuration. diff --git a/content/en/docs/v3.3/pluggable-components/logging.md b/content/en/docs/v3.3/pluggable-components/logging.md index 91acca893..2fd8de91d 100644 --- a/content/en/docs/v3.3/pluggable-components/logging.md +++ b/content/en/docs/v3.3/pluggable-components/logging.md @@ -35,14 +35,9 @@ When you install KubeSphere on Linux, you need to create a configuration file, w ```yaml logging: enabled: true # Change "false" to "true". - containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `containerruntime` to `containerd`. If you upgraded to KubeSphere 3.3.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. - - {{}} - - {{< notice note >}}By default, KubeKey will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Logging, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. + {{< notice note >}}By default, KubeKey will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `config-sample.yaml` if you want to enable Logging, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, KubeKey will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -53,7 +48,7 @@ When you install KubeSphere on Linux, you need to create a configuration file, w elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -78,14 +73,9 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu ```yaml logging: enabled: true # Change "false" to "true". - containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. If you upgraded to KubeSphere 3.3.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. - - {{}} - - {{< notice note >}}By default, ks-installer will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Logging, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. + {{< notice note >}}By default, ks-installer will install Elasticsearch internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in `cluster-configuration.yaml` if you want to enable Logging, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information before installation, ks-installer will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -96,7 +86,7 @@ As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introdu elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -127,14 +117,9 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource ```yaml logging: enabled: true # Change "false" to "true". - containerruntime: docker ``` - {{< notice info >}}To use containerd as the container runtime, change the value of the field `.logging.containerruntime` to `containerd`. If you upgraded to KubeSphere 3.3.0 from earlier versions, you have to manually add the field `containerruntime` under `logging` when enabling KubeSphere Logging system. - - {{}} - - {{< notice note >}}By default, Elasticsearch will be installed internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Logging, especially `externalElasticsearchUrl` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. + {{< notice note >}}By default, Elasticsearch will be installed internally if Logging is enabled. For a production environment, it is highly recommended that you set the following values in this yaml file if you want to enable Logging, especially `externalElasticsearchHost` and `externalElasticsearchPort`. Once you provide the following information, KubeSphere will integrate your external Elasticsearch directly instead of installing an internal one. {{}} ```yaml @@ -145,7 +130,7 @@ A Custom Resource Definition (CRD) allows users to create a new type of resource elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/en/docs/v3.3/project-administration/project-network-isolation.md b/content/en/docs/v3.3/project-administration/project-network-isolation.md index 9624aef77..7eafbb7e8 100644 --- a/content/en/docs/v3.3/project-administration/project-network-isolation.md +++ b/content/en/docs/v3.3/project-administration/project-network-isolation.md @@ -152,7 +152,7 @@ If egress traffic is controlled, you should have a clear plan of what projects, Q: Why cannot the custom monitoring system of KubeSphere get data after I enabled network isolation? -A: After you enable custom monitoring, the KubeSphere monitoring system will access the metrics of the Pod. You need to allow ingress traffic for the KubeSphere monitoring system. Otherwise, it cannot access Pod metrics. +A: After you enable custom monitoring, the KubeSphere monitoring system will access the metrics of the pod. You need to allow ingress traffic for the KubeSphere monitoring system. Otherwise, it cannot access pod metrics. KubeSphere provides a configuration item `allowedIngressNamespaces` to simplify similar configurations, which allows all projects listed in the configuration. diff --git a/content/en/docs/v3.3/project-user-guide/application-workloads/routes.md b/content/en/docs/v3.3/project-user-guide/application-workloads/routes.md index b3cdf96d4..90aac66d1 100644 --- a/content/en/docs/v3.3/project-user-guide/application-workloads/routes.md +++ b/content/en/docs/v3.3/project-user-guide/application-workloads/routes.md @@ -48,15 +48,11 @@ A Route on KubeSphere is the same as an [Ingress](https://kubernetes.io/docs/con 2. Select a mode, configure routing rules, click **√**, and click **Next**. - * **Auto Generate**: KubeSphere automatically generates a domain name in the `...nip.io` format and the domain name is automatically resolved by [nip.io](https://nip.io/) into the gateway address. This mode supports only HTTP. - - * **Paths**: Map each Service to a path. You can click **Add** to add multiple paths. - - * **Specify Domain**: A user-defined domain name is used. This mode supports both HTTP and HTTPS. - - * **Domain Name**: Set a domain name for the Route. - * **Protocol**: Select `http` or `https`. If `https` is selected, you need to select a Secret that contains the `tls.crt` (TLS certificate) and `tls.key` (TLS private key) keys used for encryption. - * **Paths**: Map each Service to a path. You can click **Add** to add multiple paths. + **Domain Name**: Set a domain name for the route. + + **Protocol**：Select `http` or `https`. If `https` is selected, you need to select a Secret that contains the `tls.crt` (TLS certificate) and `tls.key` (TLS private key) keys used for encryption. + + **Paths**：Map each service to a path. Enter a path name and select a service and port. You can also click **Add** to add multiple paths. ### (Optional) Step 3: Configure advanced settings diff --git a/content/zh/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md b/content/zh/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md index 198edb961..f40743679 100644 --- a/content/zh/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md +++ b/content/zh/docs/v3.3/cluster-administration/cluster-settings/log-collections/introduction.md @@ -45,7 +45,7 @@ KubeSphere 提供灵活的日志接收器配置方式。基于 [FluentBit Operat 如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md) 中启用了 `logging`、`events` 或 `auditing`，则会添加默认的 Elasticsearch 接收器，服务地址会设为 Elasticsearch 集群。 -当 `logging`、`events` 或 `auditing` 启用时，如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md) 中未指定 `externalElasticsearchUrl` 和 `externalElasticsearchPort`，则内置 Elasticsearch 集群会部署至 Kubernetes 集群。内置 Elasticsearch 集群仅用于测试和开发。生产环境下，建议您集成外置 Elasticsearch 集群。 +当 `logging`、`events` 或 `auditing` 启用时，如果 [ClusterConfiguration](https://github.com/kubesphere/kubekey/blob/release-2.2/docs/config-example.md) 中未指定 `externalElasticsearchHost` 和 `externalElasticsearchPort`，则内置 Elasticsearch 集群会部署至 Kubernetes 集群。内置 Elasticsearch 集群仅用于测试和开发。生产环境下，建议您集成外置 Elasticsearch 集群。 日志查询需要依靠所配置的内置或外置 Elasticsearch 集群。 diff --git a/content/zh/docs/v3.3/faq/observability/logging.md b/content/zh/docs/v3.3/faq/observability/logging.md index c2b529093..1361f2213 100644 --- a/content/zh/docs/v3.3/faq/observability/logging.md +++ b/content/zh/docs/v3.3/faq/observability/logging.md @@ -28,7 +28,7 @@ weight: 16310 kubectl edit cc -n kubesphere-system ks-installer ``` -2. 将 `es.elasticsearchDataXXX`、`es.elasticsearchMasterXXX` 和 `status.logging` 的注释取消，将 `es.externalElasticsearchUrl` 设置为 Elasticsearch 的地址，将 `es.externalElasticsearchPort` 设置为其端口号。以下示例供您参考： +2. 将 `es.elasticsearchDataXXX`、`es.elasticsearchMasterXXX` 和 `status.logging` 的注释取消，将 `es.externalElasticsearchHost` 设置为 Elasticsearch 的地址，将 `es.externalElasticsearchPort` 设置为其端口号。以下示例供您参考： ```yaml apiVersion: installer.kubesphere.io/v1alpha1 @@ -40,14 +40,18 @@ weight: 16310 spec: ... common: - es: - # elasticsearchDataReplicas: 1 - # elasticsearchDataVolumeSize: 20Gi - # elasticsearchMasterReplicas: 1 - # elasticsearchMasterVolumeSize: 4Gi + es: # Storage backend for logging, events and auditing. + # master: + # volumeSize: 4Gi # The volume size of Elasticsearch master nodes. + # replicas: 1 # The total number of master nodes. Even numbers are not allowed. + # resources: {} + # data: + # volumeSize: 20Gi # The volume size of Elasticsearch data nodes. + # replicas: 1 # The total number of data nodes. + # resources: {} elkPrefix: logstash logMaxAge: 7 - externalElasticsearchUrl: <192.168.0.2> + externalElasticsearchHost: <192.168.0.2> externalElasticsearchPort: <9200> ... status: diff --git a/content/zh/docs/v3.3/installing-on-linux/public-cloud/install-kubesphere-on-huaweicloud-ecs.md b/content/zh/docs/v3.3/installing-on-linux/public-cloud/install-kubesphere-on-huaweicloud-ecs.md index 8ffe03559..5cc861226 100644 --- a/content/zh/docs/v3.3/installing-on-linux/public-cloud/install-kubesphere-on-huaweicloud-ecs.md +++ b/content/zh/docs/v3.3/installing-on-linux/public-cloud/install-kubesphere-on-huaweicloud-ecs.md @@ -204,68 +204,144 @@ metadata: labels: version: v3.3.0 spec: - local_registry: "" persistence: - storageClass: "" + storageClass: "" # If there is no default StorageClass in your cluster, you need to specify an existing StorageClass here. authentication: - jwtSecret: "" + jwtSecret: "" # Keep the jwtSecret consistent with the Host Cluster. Retrieve the jwtSecret by executing "kubectl -n kubesphere-system get cm kubesphere-config -o yaml | grep -v "apiVersion" | grep jwtSecret" on the Host Cluster. + local_registry: "" # Add your private registry address if it is needed. + # dev_tag: "" # Add your kubesphere image tag you want to install, by default it's same as ks-installer release version. etcd: - monitoring: true # Whether to install etcd monitoring dashboard - endpointIps: 192.168.1.10,192.168.1.11,192.168.1.12 # etcd cluster endpointIps - port: 2379 # etcd port + monitoring: false # Enable or disable etcd monitoring dashboard installation. You have to create a Secret for etcd before you enable it. + endpointIps: localhost # etcd cluster EndpointIps. It can be a bunch of IPs here. + port: 2379 # etcd port. tlsEnable: true common: - mysqlVolumeSize: 20Gi # MySQL PVC size - minioVolumeSize: 20Gi # Minio PVC size - etcdVolumeSize: 20Gi # etcd PVC size - openldapVolumeSize: 2Gi # openldap PVC size - redisVolumSize: 2Gi # Redis PVC size - es: # Storage backend for logging, tracing, events and auditing. - elasticsearchMasterReplicas: 1 # total number of master nodes, it's not allowed to use even number - elasticsearchDataReplicas: 1 # total number of data nodes - elasticsearchMasterVolumeSize: 4Gi # Volume size of Elasticsearch master nodes - elasticsearchDataVolumeSize: 20Gi # Volume size of Elasticsearch data nodes - logMaxAge: 7 # Log retention time in built-in Elasticsearch, it is 7 days by default. - elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log - # externalElasticsearchUrl: - # externalElasticsearchPort: - console: - enableMultiLogin: false # enable/disable multiple sing on, it allows a user can be used by different users at the same time. - port: 30880 - alerting: # Whether to install KubeSphere alerting system. It enables Users to customize alerting policies to send messages to receivers in time with different time intervals and alerting levels to choose from. - enabled: true - auditing: # Whether to install KubeSphere audit log system. It provides a security-relevant chronological set of records，recording the sequence of activities happened in platform, initiated by different tenants. - enabled: true - devops: # Whether to install KubeSphere DevOps System. It provides out-of-box CI/CD system based on Jenkins, and automated workflow tools including Source-to-Image & Binary-to-Image - enabled: true - jenkinsMemoryLim: 2Gi # Jenkins memory limit - jenkinsMemoryReq: 1500Mi # Jenkins memory request - jenkinsVolumeSize: 8Gi # Jenkins volume size - jenkinsJavaOpts_Xms: 512m # The following three fields are JVM parameters - jenkinsJavaOpts_Xmx: 512m + core: + console: + enableMultiLogin: true # Enable or disable simultaneous logins. It allows different users to log in with the same account at the same time. + port: 30880 + type: NodePort + # apiserver: # Enlarge the apiserver and controller manager's resource requests and limits for the large cluster + # resources: {} + # controllerManager: + # resources: {} + redis: + enabled: false + enableHA: false + volumeSize: 2Gi # Redis PVC size. + openldap: + enabled: false + volumeSize: 2Gi # openldap PVC size. + minio: + volumeSize: 20Gi # Minio PVC size. + monitoring: + # type: external # Whether to specify the external prometheus stack, and need to modify the endpoint at the next line. + endpoint: http://prometheus-operated.kubesphere-monitoring-system.svc:9090 # Prometheus endpoint to get metrics data. + GPUMonitoring: # Enable or disable the GPU-related metrics. If you enable this switch but have no GPU resources, Kubesphere will set it to zero. + enabled: false + gpu: # Install GPUKinds. The default GPU kind is nvidia.com/gpu. Other GPU kinds can be added here according to your needs. + kinds: + - resourceName: "nvidia.com/gpu" + resourceType: "GPU" + default: true + es: # Storage backend for logging, events and auditing. + # master: + # volumeSize: 4Gi # The volume size of Elasticsearch master nodes. + # replicas: 1 # The total number of master nodes. Even numbers are not allowed. + # resources: {} + # data: + # volumeSize: 20Gi # The volume size of Elasticsearch data nodes. + # replicas: 1 # The total number of data nodes. + # resources: {} + logMaxAge: 7 # Log retention time in built-in Elasticsearch. It is 7 days by default. + elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. + basicAuth: + enabled: false + username: "" + password: "" + externalElasticsearchHost: "" + externalElasticsearchPort: "" + alerting: # (CPU: 0.1 Core, Memory: 100 MiB) It enables users to customize alerting policies to send messages to receivers in time with different time intervals and alerting levels to choose from. + enabled: false # Enable or disable the KubeSphere Alerting System. + # thanosruler: + # replicas: 1 + # resources: {} + auditing: # Provide a security-relevant chronological set of records，recording the sequence of activities happening on the platform, initiated by different tenants. + enabled: false # Enable or disable the KubeSphere Auditing Log System. + # operator: + # resources: {} + # webhook: + # resources: {} + devops: # (CPU: 0.47 Core, Memory: 8.6 G) Provide an out-of-the-box CI/CD system based on Jenkins, and automated workflow tools including Source-to-Image & Binary-to-Image. + enabled: false # Enable or disable the KubeSphere DevOps System. + # resources: {} + jenkinsMemoryLim: 2Gi # Jenkins memory limit. + jenkinsMemoryReq: 1500Mi # Jenkins memory request. + jenkinsVolumeSize: 8Gi # Jenkins volume size. + jenkinsJavaOpts_Xms: 1200m # The following three fields are JVM parameters. + jenkinsJavaOpts_Xmx: 1600m jenkinsJavaOpts_MaxRAM: 2g - events: # Whether to install KubeSphere events system. It provides a graphical web console for Kubernetes Events exporting, filtering and alerting in multi-tenant Kubernetes clusters. - enabled: true - logging: # Whether to install KubeSphere logging system. Flexible logging functions are provided for log query, collection and management in a unified console. Additional log collectors can be added, such as Elasticsearch, Kafka and Fluentd. - enabled: true - logsidecarReplicas: 2 - metrics_server: # Whether to install metrics-server. IT enables HPA (Horizontal Pod Autoscaler). - enabled: true - monitoring: # - prometheusReplicas: 1 # Prometheus replicas are responsible for monitoring different segments of data source and provide high availability as well. - prometheusMemoryRequest: 400Mi # Prometheus request memory - prometheusVolumeSize: 20Gi # Prometheus PVC size - alertmanagerReplicas: 1 # AlertManager Replicas + events: # Provide a graphical web console for Kubernetes Events exporting, filtering and alerting in multi-tenant Kubernetes clusters. + enabled: false # Enable or disable the KubeSphere Events System. + # operator: + # resources: {} + # exporter: + # resources: {} + # ruler: + # enabled: true + # replicas: 2 + # resources: {} + logging: # (CPU: 57 m, Memory: 2.76 G) Flexible logging functions are provided for log query, collection and management in a unified console. Additional log collectors can be added, such as Elasticsearch, Kafka and Fluentd. + enabled: false # Enable or disable the KubeSphere Logging System. + logsidecar: + enabled: true + replicas: 2 + # resources: {} + metrics_server: # (CPU: 56 m, Memory: 44.35 MiB) It enables HPA (Horizontal Pod Autoscaler). + enabled: false # Enable or disable metrics-server. + monitoring: + storageClass: "" # If there is an independent StorageClass you need for Prometheus, you can specify it here. The default StorageClass is used by default. + node_exporter: + port: 9100 + # resources: {} + # kube_rbac_proxy: + # resources: {} + # kube_state_metrics: + # resources: {} + # prometheus: + # replicas: 1 # Prometheus replicas are responsible for monitoring different segments of data source and providing high availability. + # volumeSize: 20Gi # Prometheus PVC size. + # resources: {} + # operator: + # resources: {} + # alertmanager: + # replicas: 1 # AlertManager Replicas. + # resources: {} + # notification_manager: + # resources: {} + # operator: + # resources: {} + # proxy: + # resources: {} + gpu: # GPU monitoring-related plug-in installation. + nvidia_dcgm_exporter: # Ensure that gpu resources on your hosts can be used normally, otherwise this plug-in will not work properly. + enabled: false # Check whether the labels on the GPU hosts contain "nvidia.com/gpu.present=true" to ensure that the DCGM pod is scheduled to these nodes. + # resources: {} multicluster: - clusterRole: none # host | member | none # You can install a solo cluster, or specify it as the role of host or member cluster - networkpolicy: # Network policies allow network isolation within the same cluster, which means firewalls can be set up between certain instances (Pods). - enabled: true - notification: # It supports notification management in multi-tenant Kubernetes clusters. It allows you to set AlertManager as its sender, and receivers include Email, Wechat Work, and Slack. - enabled: true - openpitrix: # Whether to install KubeSphere App Store. It provides an application store for Helm-based applications, and offer application lifecycle management - enabled: true - servicemesh: # Whether to install KubeSphere Service Mesh (Istio-based). It provides fine-grained traffic management, observability and tracing, and offer visualization for traffic topology - enabled: true + clusterRole: none # host | member | none # You can install a solo cluster, or specify it as the Host or Member Cluster. + network: + networkpolicy: # Network policies allow network isolation within the same cluster, which means firewalls can be set up between certain instances (Pods). + # Make sure that the CNI network plugin used by the cluster supports NetworkPolicy. There are a number of CNI network plugins that support NetworkPolicy, including Calico, Cilium, Kube-router, Romana and Weave Net. + enabled: false # Enable or disable network policies. + ippool: # Use Pod IP Pools to manage the Pod network address space. Pods to be created can be assigned IP addresses from a Pod IP Pool. + type: none # Specify "calico" for this field if Calico is used as your CNI plugin. "none" means that Pod IP Pools are disabled. + topology: # Use Service Topology to view Service-to-Service communication based on Weave Scope. + type: none # Specify "weave-scope" for this field to enable Service Topology. "none" means that Service Topology is disabled. + openpitrix: # An App Store that is accessible to all platform tenants. You can use it to manage apps across their entire lifecycle. + store: + enabled: false # Enable or disable the KubeSphere App Store. + servicemesh: # (0.3 Core, 300 MiB) Provide fine-grained traffic management, observability and tracing, and visualized traffic topology. + enabled: false # Base component (pilot). Enable or disable KubeSphere Service Mesh (Istio-based). ``` #### 持久化存储配置 diff --git a/content/zh/docs/v3.3/pluggable-components/auditing-logs.md b/content/zh/docs/v3.3/pluggable-components/auditing-logs.md index 5d0f160a0..b0cf450db 100644 --- a/content/zh/docs/v3.3/pluggable-components/auditing-logs.md +++ b/content/zh/docs/v3.3/pluggable-components/auditing-logs.md @@ -34,7 +34,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 ``` {{< notice note >}} -默认情况下，如果启用了审计功能，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +默认情况下，如果启用了审计功能，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -45,7 +45,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -73,7 +73,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 ``` {{< notice note >}} -默认情况下，如果启用了审计功能，ks-installer 会安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +默认情况下，如果启用了审计功能，ks-installer 会安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -84,7 +84,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -116,7 +116,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 ``` {{< notice note >}} -默认情况下，如果启用了审计功能，将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +默认情况下，如果启用了审计功能，将安装内置 Elasticsearch。对于生产环境，如果您想启用审计功能，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -127,7 +127,7 @@ KubeSphere 审计日志系统提供了一套与安全相关并按时间顺序排 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/zh/docs/v3.3/pluggable-components/events.md b/content/zh/docs/v3.3/pluggable-components/events.md index 417c6ddea..992e03f45 100644 --- a/content/zh/docs/v3.3/pluggable-components/events.md +++ b/content/zh/docs/v3.3/pluggable-components/events.md @@ -36,7 +36,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 ``` {{< notice note >}} -默认情况下，如果启用了事件系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用事件系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +默认情况下，如果启用了事件系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用事件系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -47,7 +47,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -75,7 +75,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 ``` {{< notice note >}} -对于生产环境，如果您想启用事件系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +对于生产环境，如果您想启用事件系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -86,7 +86,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -121,7 +121,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 {{< notice note >}} -默认情况下，如果启用了事件系统，将会安装内置 Elasticsearch。对于生产环境，如果您想启用事件系统，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在文件中提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 +默认情况下，如果启用了事件系统，将会安装内置 Elasticsearch。对于生产环境，如果您想启用事件系统，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在文件中提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -132,7 +132,7 @@ KubeSphere 事件系统使用户能够跟踪集群内部发生的事件，例如 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/zh/docs/v3.3/pluggable-components/kubeedge.md b/content/zh/docs/v3.3/pluggable-components/kubeedge.md index 2ccd413e8..25b65e461 100644 --- a/content/zh/docs/v3.3/pluggable-components/kubeedge.md +++ b/content/zh/docs/v3.3/pluggable-components/kubeedge.md @@ -35,21 +35,21 @@ KubeEdge 的组件在两个单独的位置运行——云上和边缘节点上 ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false ``` 3. 将 `kubeedge.cloudCore.cloudHub.advertiseAddress` 的值设置为集群的公共 IP 地址或边缘节点可以访问的 IP 地址。编辑完成后保存文件。 @@ -72,24 +72,24 @@ KubeEdge 的组件在两个单独的位置运行——云上和边缘节点上 2. 在本地 `cluster-configuration.yaml` 文件中，搜索 `edgeruntime` 和 `kubeedge`，然后将它们 `enabled` 值从 `false` 更改为 `true` 以便开启所有 KubeEdge 组件。完成后保存文件。 - ```yaml + ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false - ``` + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false + ``` 3. 将 `kubeedge.cloudCore.cloudHub.advertiseAddress` 的值设置为集群的公共 IP 地址或边缘节点可以访问的 IP 地址。 @@ -115,24 +115,24 @@ KubeEdge 的组件在两个单独的位置运行——云上和边缘节点上 4. 在该配置文件中，搜索 `edgeruntime` 和 `kubeedge`，然后将它们 `enabled` 值从 `false` 更改为 `true` 以便开启所有 KubeEdge 组件。完成后保存文件。 - ```yaml + ```yaml edgeruntime: # Add edge nodes to your cluster and deploy workloads on edge nodes. - enabled: false - kubeedge: # kubeedge configurations - enabled: false - cloudCore: - cloudHub: - advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. + enabled: false + kubeedge: # kubeedge configurations + enabled: false + cloudCore: + cloudHub: + advertiseAddress: # At least a public IP address or an IP address which can be accessed by edge nodes must be provided. - "" # Note that once KubeEdge is enabled, CloudCore will malfunction if the address is not provided. - service: - cloudhubNodePort: "30000" - cloudhubQuicNodePort: "30001" - cloudhubHttpsNodePort: "30002" - cloudstreamNodePort: "30003" - tunnelNodePort: "30004" - # resources: {} - # hostNetWork: false - ``` + service: + cloudhubNodePort: "30000" + cloudhubQuicNodePort: "30001" + cloudhubHttpsNodePort: "30002" + cloudstreamNodePort: "30003" + tunnelNodePort: "30004" + # resources: {} + # hostNetWork: false + ``` 5. 将 `kubeedge.cloudCore.cloudHub.advertiseAddress` 的值设置为集群的公共 IP 地址或边缘节点可以访问的 IP 地址。完成后，点击右下角的**确定**保存配置。 diff --git a/content/zh/docs/v3.3/pluggable-components/logging.md b/content/zh/docs/v3.3/pluggable-components/logging.md index e7206c4ca..daf320129 100644 --- a/content/zh/docs/v3.3/pluggable-components/logging.md +++ b/content/zh/docs/v3.3/pluggable-components/logging.md @@ -35,14 +35,9 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 - containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.3.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 - - {{}} - - {{< notice note >}}默认情况下，如果启用了日志系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 + {{< notice note >}}默认情况下，如果启用了日志系统，KubeKey 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `config-sample.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，KubeKey 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -53,7 +48,7 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -78,14 +73,9 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 - containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.3.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 - - {{}} - - {{< notice note >}}默认情况下，如果启用了日志系统，ks-installer 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 + {{< notice note >}}默认情况下，如果启用了日志系统，ks-installer 将安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在 `cluster-configuration.yaml` 中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在安装前提供以下信息后，ks-installer 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -96,7 +86,7 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` @@ -127,14 +117,9 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 ```yaml logging: enabled: true # 将“false”更改为“true”。 - containerruntime: docker ``` - {{< notice info >}}若使用 containerd 作为容器运行时，请将 `.logging.containerruntime` 字段的值更改为 `containerd`。如果您从低版本升级至 KubeSphere 3.3.0，则启用 KubeSphere 日志系统时必须在 `logging` 字段下手动添加 `containerruntime` 字段。 - - {{}} - - {{< notice note >}}默认情况下，如果启用了日志系统，将会安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchUrl` 和 `externalElasticsearchPort`。在文件中提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 + {{< notice note >}}默认情况下，如果启用了日志系统，将会安装内置 Elasticsearch。对于生产环境，如果您想启用日志系统，强烈建议在该 YAML 文件中设置以下值，尤其是 `externalElasticsearchHost` 和 `externalElasticsearchPort`。在文件中提供以下信息后，KubeSphere 将直接对接您的外部 Elasticsearch，不再安装内置 Elasticsearch。 {{}} ```yaml @@ -145,7 +130,7 @@ KubeSphere 为日志收集、查询和管理提供了一个强大的、全面的 elasticsearchDataVolumeSize: 20Gi # The volume size of Elasticsearch data nodes. logMaxAge: 7 # Log retention day in built-in Elasticsearch. It is 7 days by default. elkPrefix: logstash # The string making up index names. The index name will be formatted as ks--log. - externalElasticsearchUrl: # The Host of external Elasticsearch. + externalElasticsearchHost: # The Host of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` diff --git a/content/zh/docs/v3.3/project-user-guide/application-workloads/routes.md b/content/zh/docs/v3.3/project-user-guide/application-workloads/routes.md index 28d429058..b2e269e28 100644 --- a/content/zh/docs/v3.3/project-user-guide/application-workloads/routes.md +++ b/content/zh/docs/v3.3/project-user-guide/application-workloads/routes.md @@ -48,15 +48,12 @@ KubeSphere 上的应用路由和 Kubernetes 上的 [Ingress](https://kubernetes. 2. 选择一种模式来配置路由规则，点击 **√**，然后点击**下一步**。 - * **自动生成**：KubeSphere 自动以`<服务名称>.<项目名称>.<网关地址>.nip.io` 格式生成域名，该域名由 [nip.io](https://nip.io/) 自动解析为网关地址。该模式仅支持 HTTP。 - - * **路径**：将每个服务映射到一条路径。您可以点击**添加**来添加多条路径。 - - * **指定域名**：使用用户定义的域名。此模式同时支持 HTTP 和 HTTPS。 - - * **域名**：为应用路由设置域名。 - * **协议**：选择 `http` 或 `https`。如果选择了 `https`，则需要选择包含 `tls.crt`（TLS 证书）和 `tls.key`（TLS 私钥）的密钥用于加密。 - * **路径**：将每个服务映射到一条路径。您可以点击**添加**来添加多条路径。 + **域名**：指定自定义域名。 + + **协议**：选择 `http` 或 `https`。如果选择了 `https`，则需要选择包含 `tls.crt`（TLS 证书）和 `tls.key`（TLS 私钥）的保密字典用于加密。 + + **路径**：将每个服务映射到一条路径。输入路径名，并选择服务和端口。您也可以点击**添加**来添加多条路径。 + ### （可选）步骤 3：配置高级设置