Skip to content

Commit e9b0998

Browse files
ganesh-k13ganesh-k13
committed
WAF: Removed definition from docs
1 parent fcf2710 commit e9b0998

2 files changed

Lines changed: 0 additions & 303 deletions

File tree

‎crd/waf/README.md‎

Lines changed: 0 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -47,172 +47,6 @@ Based on the type of security checks, you can specify the metadata and use the C
4747

4848
The WAF CRD is available in the Citrix ingress controller GitHub repository at [waf-crd.yaml](./waf-crd.yaml). The WAF CRD provides attributes for the various options that are required to define the web application firewall policies on Citrix ADC.
4949

50-
The following is the WAF CRD definition:
51-
52-
```yml
53-
apiVersion: apiextensions.k8s.io/v1
54-
kind: CustomResourceDefinition
55-
metadata:
56-
name: wafs.citrix.com
57-
spec:
58-
group: citrix.com
59-
names:
60-
kind: waf
61-
plural: wafs
62-
singular: waf
63-
scope: Namespaced
64-
versions:
65-
- name: v1
66-
served: true
67-
storage: true
68-
subresources:
69-
status: {}
70-
additionalPrinterColumns:
71-
- name: Status
72-
type: string
73-
description: "Current Status of the CRD"
74-
jsonPath: .status.state
75-
- name: Message
76-
type: string
77-
description: "Status Message"
78-
jsonPath: .status.status_message
79-
schema:
80-
openAPIV3Schema:
81-
type: object
82-
required: [spec]
83-
properties:
84-
status:
85-
type: object
86-
properties:
87-
state:
88-
type: string
89-
status_message:
90-
type: string
91-
spec:
92-
type: object
93-
properties:
94-
ingressclass:
95-
type: string
96-
description: "Ingress class, if not specified then all citrix ingress controllers in the cluster will process the resource otherwise only the controller with that ingress class will process this resource"
97-
servicenames:
98-
description: 'Name of the services to which the waf policies are applied.'
99-
type: array
100-
items:
101-
type: string
102-
maxLength: 127
103-
application_type:
104-
description: 'Type of applications to protect'
105-
type: array
106-
items:
107-
type: string
108-
enum: ['HTML', 'JSON', 'XML']
109-
signatures:
110-
description: 'Location of external signature file'
111-
type: string
112-
redirect_url:
113-
description: ''
114-
type: string
115-
html_error_object:
116-
description: 'Location of customized error page to respond when html or common violation are hit'
117-
type: string
118-
xml_error_object:
119-
description: 'Location of customized error page to respond when xml violations are hit'
120-
type: string
121-
json_error_object:
122-
description: 'Location of customized error page to respond when json violations are hit'
123-
type: string
124-
ip_reputation:
125-
type: object
126-
x-kubernetes-preserve-unknown-fields: true
127-
description: 'Enabling IP reputation feature'
128-
target:
129-
description: 'To control what traffic to be inspected by Web Application Firewall. If you do not provide the target, everything will be inspected by default'
130-
type: object
131-
properties:
132-
path:
133-
type: array
134-
description: "List of http urls to inspect"
135-
items:
136-
type: string
137-
description: "URL path"
138-
method:
139-
type: array
140-
description: "List of http methods to inspect"
141-
items:
142-
type: string
143-
enum: ['GET', 'PUT', 'POST','DELETE']
144-
header:
145-
type: array
146-
description: "List of http headers to inspect"
147-
items:
148-
type: string
149-
description: "header name"
150-
security_checks:
151-
description: 'To enable/disable application firewall security checks'
152-
type: object
153-
properties:
154-
common:
155-
type: object
156-
x-kubernetes-preserve-unknown-fields: true
157-
html:
158-
type: object
159-
x-kubernetes-preserve-unknown-fields: true
160-
json:
161-
type: object
162-
x-kubernetes-preserve-unknown-fields: true
163-
xml:
164-
type: object
165-
x-kubernetes-preserve-unknown-fields: true
166-
settings:
167-
description: 'To fine tune application firewall security checks default settings'
168-
type: object
169-
properties:
170-
common:
171-
type: object
172-
x-kubernetes-preserve-unknown-fields: true
173-
html:
174-
type: object
175-
x-kubernetes-preserve-unknown-fields: true
176-
json:
177-
type: object
178-
x-kubernetes-preserve-unknown-fields: true
179-
xml:
180-
type: object
181-
x-kubernetes-preserve-unknown-fields: true
182-
relaxations:
183-
description: 'Section which contains relaxation rules for known traffic and false positives'
184-
type: object
185-
properties:
186-
common:
187-
type: object
188-
x-kubernetes-preserve-unknown-fields: true
189-
html:
190-
type: object
191-
x-kubernetes-preserve-unknown-fields: true
192-
json:
193-
type: object
194-
x-kubernetes-preserve-unknown-fields: true
195-
xml:
196-
type: object
197-
x-kubernetes-preserve-unknown-fields: true
198-
enforcements:
199-
description: 'Section which contains enforcement or restriction rules'
200-
type: object
201-
properties:
202-
common:
203-
type: object
204-
x-kubernetes-preserve-unknown-fields: true
205-
html:
206-
type: object
207-
x-kubernetes-preserve-unknown-fields: true
208-
json:
209-
type: object
210-
x-kubernetes-preserve-unknown-fields: true
211-
xml:
212-
type: object
213-
x-kubernetes-preserve-unknown-fields: true
214-
```
215-
21650
## WAF CRD attributes
21751

21852
The following table lists the various attributes provided in the WAF CRD:

‎docs/crds/waf.md‎

Lines changed: 0 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -47,143 +47,6 @@ Based on the type of security checks, you can specify the metadata and use the C
4747

4848
The WAF CRD is available in the Citrix ingress controller GitHub repository at [waf-crd.yaml](https://github.com/citrix/citrix-k8s-ingress-controller/blob/master/crd/waf/waf-crd.yaml). The WAF CRD provides attributes for the various options that are required to define the web application firewall policies on Citrix ADC.
4949

50-
The following is the WAF CRD definition:
51-
52-
```yml
53-
apiVersion: apiextensions.k8s.io/v1beta1
54-
kind: CustomResourceDefinition
55-
metadata:
56-
name: wafs.citrix.com
57-
spec:
58-
group: citrix.com
59-
version: v1
60-
names:
61-
kind: waf
62-
plural: wafs
63-
singular: waf
64-
scope: Namespaced
65-
subresources:
66-
status: {}
67-
additionalPrinterColumns:
68-
- name: Status
69-
type: string
70-
description: "Current Status of the CRD"
71-
JSONPath: .status.state
72-
- name: Message
73-
type: string
74-
description: "Status Message"
75-
JSONPath: .status.status_message
76-
validation:
77-
openAPIV3Schema:
78-
required: [spec]
79-
properties:
80-
spec:
81-
type: object
82-
properties:
83-
servicenames:
84-
description: "Name of the services to which the waf policies are applied."
85-
type: array
86-
items:
87-
type: string
88-
maxLength: 127
89-
application_type:
90-
description: "Type of applications to protect"
91-
type: array
92-
items
93-
type: string
94-
enum: ["HTML", "JSON", "XML"]
95-
signatures:
96-
description: "Location of external signature file"
97-
type: string
98-
redirect_url:
99-
description: ""
100-
type: string
101-
html_error_object:
102-
description: "Location of customized error page to respond when html or common violation are hit"
103-
type: string
104-
xml_error_object:
105-
description: "Location of customized error page to respond when xml violations are hit"
106-
type: string
107-
json_error_object:
108-
description: "Location of customized error page to respond when json violations are hit"
109-
type: string
110-
ip_reputation:
111-
description: "Enabling IP reputation feature"
112-
oneOf:
113-
- type: string
114-
- type: object
115-
target:
116-
description: "To control what traffic to be inspected by Web Application Firewall. If you do not provide the target, everything will be inspected by default"
117-
type: object
118-
properties:
119-
paths:
120-
type: array
121-
description: "List of http urls to inspect"
122-
items:
123-
type: string
124-
description: "URL path"
125-
method:
126-
type: array
127-
description: "List of http methods to inspect"
128-
items:
129-
type: string
130-
enum: ["GET", "PUT", "POST","DELETE"]
131-
header:
132-
type: array
133-
description: "List of http headers to inspect"
134-
items:
135-
type: string
136-
description: "header name"
137-
security_checks:
138-
description: "To enable/disable application firewall security checks"
139-
type: object
140-
properties:
141-
common:
142-
type: object
143-
html:
144-
type: object
145-
json:
146-
type: object
147-
xml:
148-
type: object
149-
settings:
150-
description: "To fine tune application firewall security checks default settings"
151-
type: object
152-
properties:
153-
common:
154-
type: object
155-
html:
156-
type: object
157-
json:
158-
type: object
159-
xml:
160-
type: object
161-
relaxations:
162-
description: "Section which contains relaxation rules for known traffic and false positives"
163-
type: object
164-
properties:
165-
common:
166-
type: object
167-
html:
168-
type: object
169-
json:
170-
type: object
171-
xml:
172-
type: object
173-
enforcements:
174-
description: "Section which contains enforcement or restriction rules"
175-
type: object
176-
properties:
177-
common:
178-
type: object
179-
html:
180-
type: object
181-
json:
182-
type: object
183-
xml:
184-
type: object
185-
```
186-
18750
## WAF CRD attributes
18851

18952
The following table lists the various attributes provided in the WAF CRD:

0 commit comments

Comments
 (0)