Skip to content

Commit 3060fc0

Browse files
authored
Merge pull request #592 from citrix/troubleshooting-update
updated the troubleshooting CIC section
2 parents 7d8dc37 + f03ca5e commit 3060fc0

1 file changed

Lines changed: 24 additions & 6 deletions

File tree

docs/troubleshooting/troubleshooting-cic.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,33 @@
11
# Troubleshooting the Citrix ingress controller during runtime
22

3+
You can use te following tools available with Citrix ingress controller to help you in troubleshooting.
4+
5+
## Kubectl plug-in for NetScaler
6+
7+
NetScaler provides a [kubectl plug-in](https://github.com/netscaler/modern-apps-toolkit/tree/main/netscaler-k8s-plugin) to inspect ingress controller deployments and aids in troubleshooting operations. You can inspect the NetScaler configuration and related Kubernetes components using the subcommands available with this plug-in.
8+
9+
Using the [support subcommand](https://github.com/netscaler/modern-apps-toolkit/tree/main/netscaler-k8s-plugin#support-command) you can get NetScaler (show techsupport) and ingress controller support bundle.
10+
11+
You can collect and share the support bundle information with the support team for faster resolution.
12+
13+
## Citrix ingress controller diagnostics Tool
14+
15+
[Citrix ingress controller diagnostics tool](https://github.com/netscaler/modern-apps-toolkit/tree/main/cic_diagnostics_tool) is a simple shell script that collects information related to Citrix ingress Controller and applications deployed in the Kubernetes cluster.
16+
17+
## Helpful commands for troubleshooting
18+
319
You can debug the Citrix ingress controller using the following methods:
420

5-
- Event based debugging
6-
- Log based debugging
21+
- Event based debugging
22+
- Log based debugging
23+
24+
Providing the outputs of the commands in this section helps the support team in troubleshooting Citrix ingress controller.
725

8-
## Event based debugging
26+
### Event based debugging
927

1028
Events are Kubernetes entities which can provide information about the flow of execution on other Kubernetes entities.
1129

12-
Event based debugging for the Citrix ingress controller is enabled at the pod level. To enable event based debugging, the RBAC cluster role permissions for the pod should be same as the cluster role permissions present in the [citrix-k8s-ingress-controller.yaml](https://github.com/citrix/citrix-k8s-ingress-controller/blob/master/deployment/baremetal/citrix-k8s-ingress-controller.yaml) file.
30+
Event based debugging for the Citrix ingress controller is enabled at the pod level. To enable event-based debugging, the RBAC cluster role permissions for the pod should be same as the cluster role permissions present in the [citrix-k8s-ingress-controller.yaml](https://github.com/citrix/citrix-k8s-ingress-controller/blob/master/deployment/baremetal/citrix-k8s-ingress-controller.yaml) file.
1331

1432
Use the following command to view the events for the Citrix ingress controller.
1533

@@ -38,9 +56,9 @@ In this example, the Citrix ADC has been deliberately made unreachable and the s
3856
Normal Created 33m CIC ENGINE, cic-vpx-functionaltest SUCCESS: GET Default VIP from Citrix ADC:
3957
Warning Created 17s CIC ENGINE, cic-vpx-functionaltest UNREACHABLE: Citrix ADC: Check Connectivity::<Citrix ADC IP>:80
4058

41-
You can use the events section to check the flow of events within the Citrix ingress controller. Events provide information on the flow of events. For further debugging, you should check logs of the Citrix ingress controller pod.
59+
You can use the events section to check the flow of events within the Citrix ingress controller. Events provide information on the flow of events. For further debugging, you should check the logs of the Citrix ingress controller pod.
4260

43-
## Log based debugging
61+
### Log based debugging
4462

4563
You can change the log level of the Citrix ingress controller at runtime using the ConfigMap feature. For changing the log level during runtime, see the [ConfigMap](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/configure/config-map/) documentation.
4664

0 commit comments

Comments
 (0)