Skip to content

Commit 1475d92

Browse files
committed
Add help text for the new commands
1 parent 6daa456 commit 1475d92

1 file changed

Lines changed: 80 additions & 0 deletions

File tree

src/confcom/azext_confcom/_help.py

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,3 +278,83 @@
278278
- name: Input a Kubernetes YAML file with a custom containerd socket path
279279
text: az confcom katapolicygen --yaml "./pod.json" --containerd-pull --containerd-socket-path "/my/custom/containerd.sock"
280280
"""
281+
282+
283+
helps[
284+
"confcom containers"
285+
] = """
286+
type: group
287+
short-summary: Commands which generate Security Policy Container Definitions.
288+
"""
289+
290+
291+
helps[
292+
"confcom containers from_radius"
293+
] = """
294+
type: command
295+
short-summary: Create a Security Policy Container Definition based on a Radius app template.
296+
297+
parameters:
298+
- name: --parameters -p
299+
type: string
300+
short-summary: 'Input parameters file to optionally accompany a Bicep Template'
301+
302+
- name: --idx
303+
type: int
304+
short-summary: 'The index of the container resource in the template to generate the policy for. Default is 0'
305+
306+
- name: --platform
307+
type: str
308+
short-summary: 'The name of the platform the container definition will run on'
309+
310+
311+
examples:
312+
- name: Input a Bicep Template and generate container definitions
313+
text: az confcom containers from_radius app.bicep
314+
- name: Input a Bicep Template with a bicepparam file and generate container definitions
315+
text: az confcom containers from_radius app.bicep --parameters app.bicepparam
316+
- name: Input a Bicep Template with inline parameter and generate container definitions
317+
text: az confcom containers from_radius app.bicep --parameters image=my.azurecr.io/myimage:tag
318+
- name: Input a Bicep Template and generate container definitions for the second container resource
319+
text: az confcom containers from_radius app.bicep --idx 1
320+
"""
321+
322+
323+
helps[
324+
"confcom radius"
325+
] = """
326+
type: group
327+
short-summary: Commands related to Radius.
328+
"""
329+
330+
331+
helps[
332+
"confcom radius policy"
333+
] = """
334+
type: group
335+
short-summary: Commands related to Radius policies.
336+
"""
337+
338+
339+
helps[
340+
"confcom radius policy insert"
341+
] = """
342+
type: command
343+
short-summary: Inserts a Security Policy into a Radius app template.
344+
345+
parameters:
346+
- name: --template -f
347+
type: string
348+
short-summary: 'Input parameters file to optionally accompany a Bicep Template'
349+
350+
- name: --idx
351+
type: int
352+
short-summary: 'The index of the container resource in the template to generate the policy for. Default is 0'
353+
354+
355+
examples:
356+
- name: Insert a Security Policy into a Radius app template
357+
text: az confcom radius policy insert policy.rego app.bicep
358+
- name: Insert a Security Policy into a Radius app template for the second container resource
359+
text: az confcom radius policy insert policy.rego app.bicep --idx 1
360+
"""

0 commit comments

Comments
 (0)