Skip to content

Commit

Permalink
Documentation improvements (#3391)
Browse files Browse the repository at this point in the history
  • Loading branch information
vklohiya authored May 7, 2024
1 parent 4088633 commit 491c695
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
3 changes: 2 additions & 1 deletion docs/cis-3.x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ git clone https://github.com/F5Networks/k8s-bigip-ctlr.git
Step 2: Install the RBAC for CIS Controller

```shell
cd k8s-bigip-ctlr
kubectl create -f ./docs/cis-3.x/rbac/clusterrole.yaml
```

Expand All @@ -31,7 +32,7 @@ Step 3: Install Custom Resource Definitions for CIS Controller
kubectl create -f ./docs/config_examples/customResourceDefinitions/incubator/customresourcedefinitions.yml
```

Step 4: Install CIS Deploy config CR
Step 4: Update the deploy config CR with the required parameters and create the deploy config CR

```shell
kubectl create -f ./docs/cis-3.x/deploy-config/cis-deploy-config-cr.yaml
Expand Down
9 changes: 5 additions & 4 deletions docs/cis-3.x/deploy-config/cis-deploy-config-cr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ metadata:
spec:
baseConfig:
# namespaceLabel is used to define the namespces which can be monitored by CIS
namespaceLabel: controller=cis
nodeLabel: controller=cis
# namespaceLabel: controller=cis
# nodeLabel is used to define the nodes which can be monitored by CIS
# nodeLabel: controller=cis
# controllerIdentifier is used to identify the unique CIS cluster/instance
controllerIdentifier: cluster-1
networkConfig:
Expand All @@ -20,13 +21,13 @@ spec:
# allowed values are auto, cluster, nodeport and nodeportlocal
poolMemberType: cluster
# network CIDR is optional parameter and required if your nodes are using multiple network interfaces
networkCIDR: "10.1.0.0/16"
# networkCIDR: "10.1.0.0/16"
staticRoutingMode: true
as3Config:
# debugAS3 is a optional parameter, and it is used to enable the debug logs for AS3
debugAS3: true
# post delay is a optional parameter, and it is used if AS3 is taking more time to apply the configuration
postDelayAS3: 10
# postDelayAS3: 10
bigIpConfig:
- bigIpAddress: 10.10.10.1
# bigIpLabel is used to map the ingress resource to the bigip, you can specify the bigip label in TS/IngressLink CR
Expand Down

0 comments on commit 491c695

Please sign in to comment.