KubeSphere Events

    For more information, see Event Query.

    When you implement multi-node installation of KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components.

    1. In the tutorial of , you create a default file . Modify the file by executing the following command:

      Note

      If you adopt All-in-One Installation, you do not need to create a config-sample.yaml file as you can create a cluster directly. Generally, the all-in-one mode is for users who are new to KubeSphere and look to get familiar with the system. If you want to enable Events in this mode (for example, for testing purposes), refer to to see how Events can be installed after installation.

    2. In this file, navigate to events and change false to true for enabled. Save the file after you finish.

      1. events:
      2.   enabled: true # Change "false" to "true".

      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.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
      8.   externalElasticsearchUrl: # The URL of external Elasticsearch.

    3. Create a cluster using the configuration file:

      1. ./kk create cluster -f config-sample.yaml

    Installing on Kubernetes

    1. Download the file cluster-configuration.yaml and edit it.

    2. In this local file, navigate to events and enable Events by changing false to true for enabled. Save the file after you finish.

      1. events:
      2.   enabled: true # Change "false" to "true".

      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.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
      8.   externalElasticsearchUrl: # The URL of external Elasticsearch.
      9.   externalElasticsearchPort: # The port of external Elasticsearch.

    3. Execute the following commands to start installation:

      1. kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.2.0/kubesphere-installer.yaml

    1. Log in to the console as admin. Click Platform in the upper-left corner and select Cluster Management.

    2. Click CRDs and enter clusterconfiguration in the search bar. Click the result to view its detail page.

      Info

      A Custom Resource Definition (CRD) allows users to create a new type of resources without adding another API server. They can use these resources like any other native Kubernetes objects.

    4. In this YAML file, navigate to events and change false to true for enabled. After you finish, click OK in the lower-right corner to save the configuration.

      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.

      1. es:  # Storage backend for logging, tracing, events and auditing.
      2.   elasticsearchMasterReplicas: 1   # The total number of master nodes. Even numbers are not allowed.
      3.   elasticsearchDataReplicas: 1     # The total number of data nodes.
      4.   elasticsearchMasterVolumeSize: 4Gi   # The volume size of Elasticsearch master nodes.
      5.   elasticsearchDataVolumeSize: 20Gi    # The volume size of Elasticsearch data nodes.
      6.   logMaxAge: 7                     # Log retention day in built-in Elasticsearch. It is 7 days by default.
      7.   elkPrefix: logstash              # The string making up index names. The index name will be formatted as ks-<elk_prefix>-log.
      8.   externalElasticsearchUrl: # The URL of external Elasticsearch.
      9.   externalElasticsearchPort: # The port of external Elasticsearch.

    5. You can use the web kubectl to check the installation process by executing the following command:

      1. kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f

      Note

      You can find the web kubectl tool by clicking in the lower-right corner of the console.

    Verify that you can use the Resource Event Search function from the Toolbox in the lower-right corner.

    Execute the following command to check the status of Pods:

    1. kubectl get pod -n kubesphere-logging-system

    The output may look as follows if the component runs successfully: