Adding a table of content and adapting the troubleshooting section

content/en/docs/troubleshooting/Kyverno_lacks_permissions.md

@@ -0,0 +1,16 @@
+---
+title: Kyverno Lacks Permissions
+description: >
+  Troubleshoot and fix Kyverno's permission issues during policy creation
+weight: 130
+---
+
+**Symptom**: Attempting to create a [mutate existing](../writing-policies/mutate.md#mutate-existing-resources) or [generate](../writing-policies/generate.md) policy and Kyverno throws an error similar to the one below:
+
+```
+Error from server: error when creating "my_cluster_policy.yaml": admission webhook "validate-policy.kyverno.svc" denied the request: path: spec.rules[0].generate..: system:serviceaccount:kyverno:kyverno-background-controller does not have permissions to 'create' resource source.toolkit.fluxcd.io/v1beta2/helmrepository//{{request.object.metadata.name}}. Grant proper permissions to the background controller
+```
+
+**Diagnose**: Use `kubectl` to assess whether the Kyverno background controller has the necessary permissions: `kubectl auth can-i create helmrepositories --as system:serviceaccount:kyverno:kyverno-background-controller`. If the response you get from this command is "no" then Kyverno will also receive the same.
+
+**Solution**: The background controller processes all mutations on existing resources and generations. It ships with only a minimal set of permissions. Any additional permissions are up to the user to add. Kyverno performs permissions checks upon creation/update of policies processed by the background controller. If the required permissions are not found, the operation is prevented. This is to ensure a good user experience is maintained. See the page on customizing permissions [here](../installation/customization.md#customizing-permissions) for instructions on how to easily add the permissions you require. If you have done this and still cannot proceed, likely causes include you targeting the wrong controller, one or more labels is wrong causing aggregation to not occur, or the permissions you have defined in the (Cluster)Role are incorrect (ex., specifying the resource name(s) using their singular form rather than plural). Fix the issues and re-run the `kubectl auth` command. Until it returns with a "yes" the permissions are not correct.

content/en/docs/troubleshooting/Kyverno_slow_response.md

@@ -0,0 +1,11 @@
+---
+title: Kyverno Slow Response
+description: >
+  Resolve slow Kyverno operations caused by API throttling.
+weight: 50
+---
+
+**Symptom**: Kyverno's operation seems slow in either mutating resources or validating them, causing additional time to create resources in the Kubernetes cluster.
+
+**Solution**: Check the Kyverno logs for messages about throttling. If many are found, this indicates Kyverno is making too many API calls in too rapid a succession which the Kubernetes API server will throttle. Increase the values, or set the [flags](../installation/customization.md#container-flags), `--clientRateLimitQPS` and `--clientRateLimitBurst`. While these flags have very sensible values after much field trials, in some cases they may need to be increased.
+

content/en/docs/troubleshooting/admission_reports_overloaded.md

@@ -0,0 +1,13 @@
+---
+title: Admission Reports Overloaded
+description: >
+  Resolve accumulating admission reports affecting etcd and cluster performance.
+weight: 120
+---
+
+**Symptom**: Admission reports keep accumulating in the cluster, taking more and more etcd space and slowing down requests.
+
+**Diagnose**: Please follow the [troubleshooting docs](https://github.com/kyverno/kyverno/blob/main/docs/dev/troubleshooting/reports.md) to determine if you are affected by this issue.
+
+**Solution**: Admission reports can accumulate if the reports controller is not working properly so the first thing to check is if the reports controller is running and does not continuously restarts. If the controller works as expected, another potential cause is that it fails to aggregate admission reports fast enough. This usually happens when the controller is throttled. You can fix this by increasing QPS and burst rates for the controller by setting `--clientRateLimitQPS=500` and `--clientRateLimitBurst=500`.
+Note that starting with Kyverno 1.10, two cron jobs are responsible for deleting admission reports automatically if they accumulate over a certain threshold.

content/en/docs/troubleshooting/api_server_blocked.md

@@ -0,0 +1,35 @@
+---
+title: API Server Blocked
+description: >
+  Learn how to resolve API server blockages due to Kyverno webhook timeouts and misconfigurations
+weight: 10
+---
+
+**Symptom**: Kyverno Pods are not running and the API server is timing out due to webhook timeouts. My cluster appears "broken".
+
+**Cause**: This can happen if all Kyverno Pods are down, due typically to a cluster outage or improper scaling/killing of full node groups, and policies were configure to [fail-closed](../writing-policies/policy-settings.md) while matching on Pods. This is usually only the case when the Kyverno Namespace has not been excluded (not the default behavior) or potentially system Namespaces which have cluster-critical components such as `kube-system`.
+
+**Solution**: Delete the Kyverno validating and mutating webhook configurations. When Kyverno recovers, check your Namespace exclusions. Follow the steps below. Also consider running the admission controller component with 3 replicas.
+
+1. Delete the validating and mutating webhook configurations that instruct the API server to forward requests to Kyverno:
+
+```sh
+kubectl delete validatingwebhookconfiguration kyverno-resource-validating-webhook-cfg
+kubectl delete  mutatingwebhookconfiguration kyverno-resource-mutating-webhook-cfg
+```
+
+Note that these two webhook configurations are used for resources. Other Kyverno webhooks are for internal operations and typically do not need to be deleted. When Kyverno recovers, its webhooks will be recreated based on the currently-installed policies.
+
+2. Restart Kyverno
+
+This step is typically not necessary. In case it is, either delete the Kyverno Pods or scale the Deployment down to zero and then up. For example, for an installation with three replicas in the default Namespace use:
+
+```sh
+kubectl scale deploy kyverno-admission-controller -n kyverno --replicas 0
+kubectl scale deploy kyverno-admission-controller -n kyverno --replicas 3
+```
+
+3. Consider excluding namespaces
+
+Use [Namespace selectors](../installation/customization.md#namespace-selectors) to filter requests to system Namespaces. Note that this configuration bypasses all policy checks on select Namespaces and may violate security best practices. When excluding Namespaces, it is your responsibility to ensure other controls such as Kubernetes RBAC are configured since Kyverno cannot apply any policies to objects therein. For more information, see the [Security vs Operability](../installation/_index.md#security-vs-operability) section. The Kyverno Namespace is excluded by default. And if running Kyverno on certain PaaS platforms, additional Namespaces may need to be excluded as well, for example `kube-system`.
+

content/en/docs/troubleshooting/client_side_throttling.md

@@ -0,0 +1,12 @@
+---
+title: Client-Side Throttling
+description: >
+  Resolve delays in resource creation caused by Kyverno's client-side throttling.
+weight: 100
+---
+
+
+**Symptom**: Kyverno pods emit logs stating `Waited for <n>s due to client-side throttling`; the creation of mutated resources may be delayed.
+
+**Solution**: Try increasing `clientRateLimitBurst` and `clientRateLimitQPS` (documented [here](../installation/customization.md#container-flags)). If that doesn't resolve the problem, you can experiment with slowly increasing these values. Just bear in mind that higher values place more pressure on the Kubernetes API (the client-side throttling was implemented for a reason), which could result in cluster-wide latency, so proceed with caution.
+

content/en/docs/troubleshooting/kyverno_crashes.md

@@ -0,0 +1,13 @@
+---
+title: Kyverno Crashes
+description: >
+  Resolve Kyverno crashes caused by insufficient memory in large clusters.
+weight: 70
+---
+
+**Symptom**: I have a large cluster with many objects and many Kyverno policies. Kyverno is seen to sometimes crash.
+
+**Solution**: In cases of very large scale, it may be required to increase the memory limit of the Kyverno Pod so it can keep track of these objects.
+
+1. First, see the [above troubleshooting section](#kyverno-consumes-a-lot-of-resources-or-i-see-oomkills). If changes are required, edit the necessary Kyverno Deployment and increase the memory limit on the container. Change the `resources.limits.memory` field to a larger value. Continue to monitor the memory usage by using something like the [Kubernetes metrics-server](https://github.com/kubernetes-sigs/metrics-server#installation).
+

content/en/docs/troubleshooting/kyverno_fails_eks.md

@@ -0,0 +1,16 @@
+---
+title: Kyverno Issues on EKS
+description: >
+  Troubleshoot Kyverno webhook failures and resource validation issues on EKS clusters
+weight: 90
+---
+
+**Symptom**: I'm an EKS user and I'm finding that resources that should be blocked by a Kyverno policy are not. My cluster does not use the VPC CNI.
+
+**Solution**: When using EKS with a custom CNI plug-in (ex., Calico), the Kyverno webhook cannot be reached by the API server because the control plane nodes, which cannot use a custom CNI, differ from the configuration of the worker nodes, which can. In order to resolve this, when installing Kyverno via Helm, set the `hostNetwork` option to `true`. See also [this note](https://cert-manager.io/docs/installation/compatibility/#aws-eks). AWS lists the alternate compatible CNI plug-ins [here](https://docs.aws.amazon.com/eks/latest/userguide/alternate-cni-plugins.html).
+
+**Symptom**: When creating Pods or other resources, I receive similar errors like `Error from server (InternalError): Internal error occurred: failed calling webhook "validate.kyverno.svc-fail": Post "https://kyverno-svc.kyverno.svc:443/validate?timeout=10s": context deadline exceeded`.
+
+**Solution**: When using EKS with the VPC CNI, problems may arise if the CNI plug-in is outdated. Upgrade the VPC CNI plug-in to a version supported and compatible with the Kubernetes version running in the EKS cluster.
+
+If the EKS cluster uses your own security group, some of the network traffic from the control plane to the worker nodes might be blocked (documented [here](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html)). Create an inbound rule in the security group attached to the EKS worker nodes, allowing communication on port 9443 from the EKS cluster security group.

content/en/docs/troubleshooting/kyverno_fails_gke.md

@@ -0,0 +1,10 @@
+---
+title: Kyverno Issues on GKE
+description: >
+  Troubleshoot Kyverno webhook failures on GKE private clusters with firewall rule adjustments
+weight: 80
+---
+
+**Symptom**: I'm using GKE and after installing Kyverno, my cluster is either broken or I'm seeing timeouts and other issues.
+
+**Solution**: Private GKE clusters do not allow certain communications from the control planes to the workers, which Kyverno requires to receive webhooks from the API server. In order to resolve this issue, create a firewall rule which allows the control plane to speak to workers on the Kyverno TCP port which, by default at this time, is 9443. For more details, see the [GKE documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules).

content/en/docs/troubleshooting/kyverno_oomkills.md

@@ -0,0 +1,23 @@
+---
+title: Kyverno OOMKills
+description: >
+  Troubleshoot high resource usage or OOMKills caused by Kyverno policies.
+weight: 30
+---
+
+
+**Symptom**: Kyverno is using too much memory or CPU. How can I understand what is causing this?
+
+**Solution**: It is important to understand how Kyverno experiences and processes work to determine if what you deem as "too much" is, in fact, too much. Kyverno dynamically configures its webhooks (by default but configurable) according the policies which are loaded and on what resources they match. There is no straightforward formula where resource requirements are directly proportional to, for example, number of Pods or Nodes in a cluster. The following questions need to be asked and answered to build a full picture of the resources consumed by Kyverno.
+
+1. What policies are in the cluster and on what types of resources do they match? Policies which match on wildcards (`"*"`) cause a tremendous load on Kyverno and should be avoided if possible as they instruct the Kubernetes API server to send to Kyverno _every action on every resource_ in the cluster. Even if Kyverno does not have matching policies for most of these resources, it is _required_ to respond to every single one. If even one policy matches on a wildcard, expect the resources needed by Kyverno to easily double, triple, or more.
+2. Which controller is experiencing the load? Each Kyverno controller has different responsibilities. See the [controller guide](../high-availability/_index.md#controllers-in-kyverno) for more details. Each controller can be independently scaled, but before immediately scaling in any direction take the time to study the load.
+3. Are the default requests and limits still in effect? It is possible the amount of load Kyverno (any of its controllers) is experiencing is beyond the capabilities of the default requests and limits. These defaults have been selected based on a good mix of real-world usage and feedback but **may not suit everyone**. In extremely large and active clusters, from Kyverno's perspective, you may need to increase these.
+4. What do your monitoring metrics say? Kyverno is a critical piece of cluster infrastructure and must be monitored effectively just like other pieces. There are several metrics which give a sense of how active Kyverno is, the most important being [admission request count](../monitoring/admission-requests.md). Others include consumed memory and CPU utilization. Sizing should always be done based on peak consumption and not averages.
+5. Have you checked the number of pending update requests when using generate or mutate existing rules? In addition to the admission request count metric, you can use `kubectl -n kyverno get updaterequests` to get a sense of the request count. If there are many requests in a `Pending` status this could be a sign of a permissions issue or, for clone-type generate rules with synchronization enabled, excessive updates to the source resource. Ensure you grant the background controller the required permissions to the resources and operations it needs, and ensure Kyverno is able to label clone sources.
+
+You can also follow the steps on the [Kyverno wiki](https://github.com/kyverno/kyverno/wiki/Profiling-Kyverno-on-Kubernetes) for enabling memory and CPU profiling.
+
+**Symptom**: I'm using AKS and Kyverno is using too much memory or CPU or produces many audit logs
+
+**Solution**: On AKS the Kyverno webhooks will be mutated by the AKS [Admissions Enforcer](https://learn.microsoft.com/en-us/azure/aks/faq#can-admission-controller-webhooks-impact-kube-system-and-internal-aks-namespaces) plugin, that can lead to an endless update loop. To prevent that behavior, set the annotation `"admissions.enforcer/disabled": true` to all Kyverno webhooks. When installing via Helm, the annotation can be added with `config.webhookAnnotations`. As of Kyverno 1.12, this configuration is enabled by default.

content/en/docs/troubleshooting/partial_policy_application.md

@@ -0,0 +1,14 @@
+---
+title: Partial Policy Application
+description: >
+  Resolve issues where only some Kyverno policies are applied.
+weight: 60
+---
+
+**Symptom**: Kyverno is working for some policies but not others. How can I see what's going on?
+
+**Solution**: The first thing is to check the logs from the Kyverno Pod to see if it describes why a policy or rule isn't working.
+
+1. Check the Pod logs from Kyverno. Assuming Kyverno was installed into the default Namespace called `kyverno` use the command `kubectl -n kyverno logs <kyverno_pod_name>` to show the logs. To watch the logs live, add the `-f` switch for the "follow" option.
+
+2. If no helpful information is being displayed at the default logging level, increase the level of verbosity by editing the Kyverno Deployment. To edit the Deployment, assuming Kyverno was installed into the default Namespace, use the command `kubectl -n kyverno edit deploy kyverno-<controller_type>-controller`. Find the `args` section for the container named `kyverno` and either add the `-v` switch or increase to a higher level. The flag `-v=6` will increase the logging level to its highest. Take care to revert this change once troubleshooting steps are concluded.