--- title: "KubeSphere Auditing Logs" keywords: "Kubernetes, auditing, KubeSphere, logs" description: "Learn how to enable Auditing to document platform events and activities." linkTitle: "KubeSphere Auditing Logs" weight: 6700 --- The KubeSphere Auditing Log System provides a security-relevant chronological set of records documenting the sequence of activities related to individual users, managers, or other components of the system. Each request to KubeSphere generates an event that is then written to a webhook and processed according to a certain rule. For more information, see [Auditing Log Query](../../toolbox/auditing/auditing-query/). ## Enable Auditing Logs Before Installation ### Installing on Linux When you implement multi-node installation KubeSphere on Linux, you need to create a configuration file, which lists all KubeSphere components. 1. In the tutorial of [Installing KubeSphere on Linux](../../installing-on-linux/introduction/multioverview/), you create a default file `config-sample.yaml`. Modify the file by executing the following command: ```bash vi config-sample.yaml ``` {{< notice note >}} If you adopt [All-in-One Installation](../../quick-start/all-in-one-on-linux/), 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 Auditing in this mode (for example, for testing purposes), refer to [the following section](#enable-auditing-logs-after-installation) to see how Auditing can be installed after installation. {{}} 2. In this file, navigate to `auditing` and change `false` to `true` for `enabled`. Save the file after you finish. ```yaml auditing: enabled: true # Change "false" to "true". ``` {{< 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. {{}} ```yaml es: # Storage backend for logging, tracing, events and auditing. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed. elasticsearchDataReplicas: 1 # The total number of data nodes. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes. 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 URL of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` 3. Create a cluster using the configuration file: ```bash ./kk create cluster -f config-sample.yaml ``` ### Installing on Kubernetes As you [install KubeSphere on Kubernetes](../../installing-on-kubernetes/introduction/overview/), you can enable KubeSphere Auditing first in the [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml) file. 1. Download the file [cluster-configuration.yaml](https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/cluster-configuration.yaml) and edit it. ```bash vi cluster-configuration.yaml ``` 2. In this local `cluster-configuration.yaml` file, navigate to `auditing` and enable Auditing by changing `false` to `true` for `enabled`. Save the file after you finish. ```yaml auditing: enabled: true # Change "false" to "true". ``` {{< 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. {{}} ```yaml es: # Storage backend for logging, tracing, events and auditing. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed. elasticsearchDataReplicas: 1 # The total number of data nodes. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes. 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 URL of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` 3. Execute the following commands to start installation: ```bash kubectl apply -f https://github.com/kubesphere/ks-installer/releases/download/v3.1.1/kubesphere-installer.yaml kubectl apply -f cluster-configuration.yaml ``` ## Enable Auditing Logs After Installation 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. {{< notice 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. {{}} 3. In **Resource List**, click on the right of `ks-installer` and select **Edit YAML**. 4. In this YAML file, navigate to `auditing` and change `false` to `true` for `enabled`. After you finish, click **OK** in the lower-right corner to save the configuration. ```yaml auditing: enabled: true # Change "false" to "true". ``` {{< 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. {{}} ```yaml es: # Storage backend for logging, tracing, events and auditing. elasticsearchMasterReplicas: 1 # The total number of master nodes. Even numbers are not allowed. elasticsearchDataReplicas: 1 # The total number of data nodes. elasticsearchMasterVolumeSize: 4Gi # The volume size of Elasticsearch master nodes. 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 URL of external Elasticsearch. externalElasticsearchPort: # The port of external Elasticsearch. ``` 5. You can use the web kubectl to check the installation process by executing the following command: ```bash kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=ks-install -o jsonpath='{.items[0].metadata.name}') -f ``` {{< notice note >}} You can find the web kubectl tool by clicking in the lower-right corner of the console. {{}} ## Verify the Installation of the Component {{< tabs >}} {{< tab "Verify the component on the dashboard" >}} Verify that you can use the **Auditing Operating** function from the **Toolbox** in the lower-right corner. {{}} {{< tab "Verify the component through kubectl" >}} Execute the following command to check the status of Pods: ```bash kubectl get pod -n kubesphere-logging-system ``` The output may look as follows if the component runs successfully: ```yaml NAME READY STATUS RESTARTS AGE elasticsearch-logging-curator-elasticsearch-curator-159872n9g9g 0/1 Completed 0 2d10h elasticsearch-logging-curator-elasticsearch-curator-159880tzb7x 0/1 Completed 0 34h elasticsearch-logging-curator-elasticsearch-curator-1598898q8w7 0/1 Completed 0 10h elasticsearch-logging-data-0 1/1 Running 1 2d20h elasticsearch-logging-data-1 1/1 Running 1 2d20h elasticsearch-logging-discovery-0 1/1 Running 1 2d20h fluent-bit-6v5fs 1/1 Running 1 2d20h fluentbit-operator-5bf7687b88-44mhq 1/1 Running 1 2d20h kube-auditing-operator-7574bd6f96-p4jvv 1/1 Running 1 2d20h kube-auditing-webhook-deploy-6dfb46bb6c-hkhmx 1/1 Running 1 2d20h kube-auditing-webhook-deploy-6dfb46bb6c-jp77q 1/1 Running 1 2d20h ``` {{}} {{}}