Skip to content

Commit d65726d

Browse files
sreejithgssreejithgs
authored
Merge pull request #399 from citrix/doc-latest
doc changes for CIC release 1.14.17
2 parents 75e7f23 + 72e437d commit d65726d

22 files changed

Lines changed: 1463 additions & 1290 deletions

‎crd/auth/README.md‎

Lines changed: 152 additions & 573 deletions
Large diffs are not rendered by default.

‎crd/auth/auth-crd.yaml‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,9 @@ spec:
5555
properties:
5656
authentication_host:
5757
description: |+
58-
'Fully qualified domain name (FQDN) for authentication
59-
FQDN to which the user must be redirected for
60-
authentication. This FQDN should be unique and should resolve to frontend IP of
61-
ADC with Ingress/service type LoadBalancer'
58+
'Fully qualified domain name (FQDN) for authentication.
59+
This FQDN should be unique and should resolve to frontend IP of
60+
ADC with Ingress/service type LoadBalancer (or) vip of Listener CRD'
6261
type: string
6362
maxLength: 255
6463
authentication_host_cert:
@@ -94,6 +93,11 @@ spec:
9493
is applicable.'
9594
type: string
9695
maxLength: 63
96+
listener_name:
97+
description: |+
98+
'Listener CRD name for which the authentication using forms is applicable.'
99+
type: string
100+
maxLength: 63
97101
vip:
98102
description: |+
99103
'Frontend IP of ingress for which the authentication
@@ -107,6 +111,8 @@ spec:
107111
required: [ingress_name]
108112
- properties:
109113
required: [lb_service_name]
114+
- properties:
115+
required: [listener_name]
110116
- properties:
111117
required: [vip]
112118
oneOf:
@@ -495,5 +501,4 @@ spec:
495501
- claims
496502

497503
required:
498-
- servicenames
499-
504+
- servicenames

‎crd/contentrouting/HTTPRoute.yaml‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,18 @@ metadata:
44
name: httproutes.citrix.com
55
spec:
66
group: citrix.com
7-
version: v1alpha1
7+
version: null
8+
versions:
9+
- name: v1
10+
served: true
11+
storage: true
12+
- name: v1alpha1
13+
served: true
14+
storage: false
815
names:
916
kind: HTTPRoute
1017
plural: httproutes
1118
singular: httproute
12-
scope: Namespaced
1319
subresources:
1420
status: {}
1521
additionalPrinterColumns:
@@ -21,9 +27,11 @@ spec:
2127
type: string
2228
description: "Status Message"
2329
JSONPath: .status.status_message
30+
scope: Namespaced
2431
validation:
2532
openAPIV3Schema:
2633
required: [spec]
34+
type: object
2735
properties:
2836
spec:
2937
type: object
@@ -186,12 +194,12 @@ spec:
186194
- required: [name, exact]
187195
- required: [name, contains]
188196
- required: [name, regex]
189-
method:
190-
type: string
191-
description: "HTTP method for content routing eg: POST, PUT, DELETE etc"
192-
policyExpression:
193-
type: string
194-
description: "Citrix ADC policy expressions; refer: https://docs.citrix.com/en-us/netscaler/media/expression-prefix.pdf"
197+
method:
198+
type: string
199+
description: "HTTP method for content routing eg: POST, PUT, DELETE etc"
200+
policyExpression:
201+
type: string
202+
description: "Citrix ADC policy expressions; refer: https://docs.citrix.com/en-us/netscaler/media/expression-prefix.pdf"
195203
action:
196204
type: object
197205
description: "Action for the matched rule"
@@ -217,7 +225,7 @@ spec:
217225
backendConfig:
218226
description: "General backend service options"
219227
properties:
220-
secure_backend:
228+
secureBackend:
221229
description: "Use Secure communications to the backends"
222230
type: boolean
223231
lbConfig:
@@ -254,3 +262,4 @@ spec:
254262
oneOf:
255263
- required: ["backend"]
256264
- required: ["redirect"]
265+

‎crd/contentrouting/Listener.yaml‎

Lines changed: 125 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,17 @@ metadata:
55
status:
66
spec:
77
group: citrix.com
8-
version: v1alpha1
8+
version: null
9+
versions:
10+
- name: v1
11+
served: true
12+
storage: true
13+
- name: v1alpha1
14+
served: true
15+
storage: false
916
names:
10-
kind: Listener
11-
plural: listeners
17+
kind: Listener
18+
plural: listeners
1219
singular: listener
1320
scope: Namespaced
1421
subresources:
@@ -25,6 +32,7 @@ spec:
2532
validation:
2633
openAPIV3Schema:
2734
required: [spec]
35+
type: object
2836
properties:
2937
spec:
3038
type: object
@@ -36,7 +44,18 @@ spec:
3644
description: "Protocol for this listener"
3745
vip:
3846
type: string
39-
description: "Endpoint IP address, Optional for CPX, required for Tier-1 deployments"
47+
description: "VIP address, Optional for CPX, required for Tier-1 deployments"
48+
secondaryVips:
49+
type: array
50+
description: "An array of Secondary VIPs. All the VIPs will be part of an ipset"
51+
minItems: 1
52+
items:
53+
type: string
54+
redirectPort:
55+
type: integer
56+
minimum: 1
57+
maximum: 65535
58+
description: "Port from which http traffic should be redirected to https"
4059
port:
4160
type: integer
4261
minimum: 1
@@ -46,13 +65,13 @@ spec:
4665
description: "certificates attached to the endpoints - Not applicable for HTTP"
4766
minItems: 1
4867
items:
49-
type: object
68+
type: object
5069
properties:
5170
preconfigured:
5271
type: string
5372
description: "Preconfigured Certificate name on ADC "
5473
secret:
55-
type: object
74+
type: object
5675
description: "Kuberentes secret object"
5776
required: [name]
5877
properties:
@@ -67,6 +86,102 @@ spec:
6786
default:
6887
type: boolean
6988
description: "Only one of the certificate can be marked as default which will be presented if none of the cert matches with the hostname"
89+
oneOf:
90+
- required: ["preconfigured"]
91+
- required: ["secret"]
92+
policies:
93+
type: object
94+
description: "Policies attached to the Listener"
95+
properties:
96+
httpprofile:
97+
type: object
98+
description: "HTTP profile configurations for the Listener, HTTP level configurations"
99+
properties:
100+
preconfigured:
101+
type: string
102+
description: "Preconfigured or Built-in HTTP profile name"
103+
config:
104+
type: object
105+
description: "HTTP profile configuration for the listener. For individual fields, refer:https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/configuration/ns/nshttpprofile/nshttpprofile/ Name field is auto populated"
106+
additionalProperties:
107+
type: string
108+
oneOf:
109+
- required: ["preconfigured"]
110+
- required: ["config"]
111+
tcpprofile:
112+
type: object
113+
description: "TCP level configurations, uses ns tcpprofile of citrix ADC"
114+
properties:
115+
preconfigured:
116+
description: "Preconfigured or Built-in TCP profile name"
117+
type: string
118+
config:
119+
type: object
120+
description: "TCPprofile configurations for the listener. For individual fields refer: https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/configuration/ns/nstcpprofile/ ; Name field is auto populated"
121+
additionalProperties:
122+
type: string
123+
oneOf:
124+
- required: ["preconfigured"]
125+
- required: ["config"]
126+
csvserverConfig:
127+
type: object
128+
description: "CS Vserver configuration for the listener"
129+
additionalProperties:
130+
type: string
131+
sslprofile:
132+
type: object
133+
description: "SSL profile configuration"
134+
properties:
135+
preconfigured:
136+
type: string
137+
description: "SSL profile which is preconfigured in ADC. Ciphers bound to the profile is not overriden"
138+
config:
139+
description: "Citrix ADC frontend SSL profile configurations. Refer:https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/12.0/configuration/ssl/sslprofile/ for all configurations; Name field is auto generated"
140+
type: object
141+
additionalProperties:
142+
type: string
143+
oneOf:
144+
- required: ["preconfigured"]
145+
- required: ["config"]
146+
sslciphers:
147+
type: array
148+
description: "List of ciphers to be bound to the ssl profile for the listener. Priority is as per the order in the list. A cipher suite, predefined cipher group or User created cipher group can be mentioned"
149+
minItems: 1
150+
items:
151+
type: string
152+
description: "Cipher suite, cipher group name"
153+
analyticsprofile:
154+
type: object
155+
description: "Analytics profile configuration"
156+
properties:
157+
preconfigured:
158+
type: array
159+
description: "Preconfigured Analytics profile that needs to be bound to the vserver"
160+
minItems: 1
161+
items:
162+
type: string
163+
description: "Name of the analytics profile preconfigured that will be bound to the Vserver"
164+
config:
165+
type: array
166+
description: "An array of analytics to be enabled"
167+
minItems: 1
168+
items:
169+
type: object
170+
description: "Anlytics to be enabled"
171+
required: ['type']
172+
properties:
173+
type:
174+
description: "Analytics profile to be enabled, you can enable one or more of the webinsight, tcpinsight, securityinsight, videoinsight, hdxinsight, gatewayinsight, timeseries, lsninsight, botinsight "
175+
type: string
176+
enum: ["webinsight", "tcpinsight", "securityinsight", "videoinsight", "hdxinsight", "gatewayinsight", "timeseries", "lsninsight", "botinsight"]
177+
parameters:
178+
type: object
179+
description: "Additional parameters for analytics profile. Please refer:https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/analytics/analyticsprofile/"
180+
additionalProperties:
181+
type: string
182+
oneOf:
183+
- required: ["preconfigured"]
184+
- required: ["config"]
70185
routes:
71186
type: array
72187
description: "List of route objects attached to the listener"
@@ -88,7 +203,7 @@ spec:
88203
additionalProperties:
89204
type: string
90205
oneOf:
91-
- required: [name, namespace]
206+
- required: [name, namespace]
92207
- required: [labelSelector]
93208
defaultAction:
94209
type: object
@@ -118,8 +233,9 @@ spec:
118233
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
119234
backendConfig:
120235
description: "General backend service options"
236+
type: object
121237
properties:
122-
secure_backend:
238+
secureBackend:
123239
description: "Use Secure communications to the backends"
124240
type: boolean
125241
lbConfig:
@@ -155,4 +271,4 @@ spec:
155271
maximum: 599
156272
oneOf:
157273
- required: ["backend"]
158-
- required: ["redirect"]
274+
- required: ["redirect"]

0 commit comments

Comments
 (0)