Browse code

Updated auto generated doc for pod-network CLI commands

Ravi Sankar Penta authored on 2016/08/13 05:52:06
Showing 13 changed files
... ...
@@ -409,6 +409,22 @@ Update the stored version of API objects
409 409
 ====
410 410
 
411 411
 
412
+== oadm pod-network isolate-projects
413
+Isolate project network
414
+
415
+====
416
+
417
+[options="nowrap"]
418
+----
419
+	# Provide isolation for project p1
420
+	oadm pod-network isolate-projects <p1>
421
+
422
+	# Allow all projects with label name=top-secret to have their own isolated project network
423
+	oadm pod-network isolate-projects --selector='name=top-secret'
424
+----
425
+====
426
+
427
+
412 428
 == oadm pod-network join-projects
413 429
 Join project network
414 430
 
... ...
@@ -409,6 +409,22 @@ Update the stored version of API objects
409 409
 ====
410 410
 
411 411
 
412
+== oc adm pod-network isolate-projects
413
+Isolate project network
414
+
415
+====
416
+
417
+[options="nowrap"]
418
+----
419
+	# Provide isolation for project p1
420
+	oc adm pod-network isolate-projects <p1>
421
+
422
+	# Allow all projects with label name=top-secret to have their own isolated project network
423
+	oc adm pod-network isolate-projects --selector='name=top-secret'
424
+----
425
+====
426
+
427
+
412 428
 == oc adm pod-network join-projects
413 429
 Join project network
414 430
 
... ...
@@ -45,6 +45,7 @@ oadm-migrate.1
45 45
 oadm-new-project.1
46 46
 oadm-options.1
47 47
 oadm-overwrite-policy.1
48
+oadm-pod-network-isolate-projects.1
48 49
 oadm-pod-network-join-projects.1
49 50
 oadm-pod-network-make-projects-global.1
50 51
 oadm-pod-network.1
... ...
@@ -45,6 +45,7 @@ oc-adm-migrate.1
45 45
 oc-adm-new-project.1
46 46
 oc-adm-options.1
47 47
 oc-adm-overwrite-policy.1
48
+oc-adm-pod-network-isolate-projects.1
48 49
 oc-adm-pod-network-join-projects.1
49 50
 oc-adm-pod-network-make-projects-global.1
50 51
 oc-adm-pod-network.1
... ...
@@ -45,6 +45,7 @@ openshift-admin-migrate.1
45 45
 openshift-admin-new-project.1
46 46
 openshift-admin-options.1
47 47
 openshift-admin-overwrite-policy.1
48
+openshift-admin-pod-network-isolate-projects.1
48 49
 openshift-admin-pod-network-join-projects.1
49 50
 openshift-admin-pod-network-make-projects-global.1
50 51
 openshift-admin-pod-network.1
... ...
@@ -127,6 +128,7 @@ openshift-cli-adm-migrate.1
127 127
 openshift-cli-adm-new-project.1
128 128
 openshift-cli-adm-options.1
129 129
 openshift-cli-adm-overwrite-policy.1
130
+openshift-cli-adm-pod-network-isolate-projects.1
130 131
 openshift-cli-adm-pod-network-join-projects.1
131 132
 openshift-cli-adm-pod-network-make-projects-global.1
132 133
 openshift-cli-adm-pod-network.1
133 134
new file mode 100644
... ...
@@ -0,0 +1,116 @@
0
+.TH "OADM POD-NETWORK" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+oadm pod\-network isolate\-projects \- Isolate project network
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBoadm pod\-network isolate\-projects\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Isolate project network
16
+
17
+.PP
18
+Allows projects to isolate their network from other projects when using the redhat/openshift\-ovs\-multitenant network plugin.
19
+
20
+
21
+.SH OPTIONS
22
+.PP
23
+\fB\-\-selector\fP=""
24
+    Label selector to filter projects. Either pass one/more projects as arguments or use this project selector
25
+
26
+
27
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
28
+.PP
29
+\fB\-\-api\-version\fP=""
30
+    DEPRECATED: The API version to use when talking to the server
31
+
32
+.PP
33
+\fB\-\-as\fP=""
34
+    Username to impersonate for the operation.
35
+
36
+.PP
37
+\fB\-\-certificate\-authority\fP=""
38
+    Path to a cert. file for the certificate authority.
39
+
40
+.PP
41
+\fB\-\-client\-certificate\fP=""
42
+    Path to a client certificate file for TLS.
43
+
44
+.PP
45
+\fB\-\-client\-key\fP=""
46
+    Path to a client key file for TLS.
47
+
48
+.PP
49
+\fB\-\-cluster\fP=""
50
+    The name of the kubeconfig cluster to use
51
+
52
+.PP
53
+\fB\-\-config\fP=""
54
+    Path to the config file to use for CLI requests.
55
+
56
+.PP
57
+\fB\-\-context\fP=""
58
+    The name of the kubeconfig context to use
59
+
60
+.PP
61
+\fB\-\-google\-json\-key\fP=""
62
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
63
+
64
+.PP
65
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
66
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
67
+
68
+.PP
69
+\fB\-\-log\-flush\-frequency\fP=0
70
+    Maximum number of seconds between log flushes
71
+
72
+.PP
73
+\fB\-\-match\-server\-version\fP=false
74
+    Require server version to match client version
75
+
76
+.PP
77
+\fB\-n\fP, \fB\-\-namespace\fP=""
78
+    If present, the namespace scope for this CLI request.
79
+
80
+.PP
81
+\fB\-\-server\fP=""
82
+    The address and port of the Kubernetes API server
83
+
84
+.PP
85
+\fB\-\-token\fP=""
86
+    Bearer token for authentication to the API server.
87
+
88
+.PP
89
+\fB\-\-user\fP=""
90
+    The name of the kubeconfig user to use
91
+
92
+
93
+.SH EXAMPLE
94
+.PP
95
+.RS
96
+
97
+.nf
98
+	# Provide isolation for project p1
99
+	oadm pod\-network isolate\-projects <p1>
100
+
101
+	# Allow all projects with label name=top\-secret to have their own isolated project network
102
+	oadm pod\-network isolate\-projects \-\-selector='name=top\-secret'
103
+
104
+.fi
105
+.RE
106
+
107
+
108
+.SH SEE ALSO
109
+.PP
110
+\fBoadm\-pod\-network(1)\fP,
111
+
112
+
113
+.SH HISTORY
114
+.PP
115
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -87,7 +87,7 @@ This command provides common pod network operations for administrators.
87 87
 
88 88
 .SH SEE ALSO
89 89
 .PP
90
-\fBoadm(1)\fP, \fBoadm\-pod\-network\-join\-projects(1)\fP, \fBoadm\-pod\-network\-make\-projects\-global(1)\fP,
90
+\fBoadm(1)\fP, \fBoadm\-pod\-network\-isolate\-projects(1)\fP, \fBoadm\-pod\-network\-join\-projects(1)\fP, \fBoadm\-pod\-network\-make\-projects\-global(1)\fP,
91 91
 
92 92
 
93 93
 .SH HISTORY
94 94
new file mode 100644
... ...
@@ -0,0 +1,116 @@
0
+.TH "OC ADM POD-NETWORK" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+oc adm pod\-network isolate\-projects \- Isolate project network
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBoc adm pod\-network isolate\-projects\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Isolate project network
16
+
17
+.PP
18
+Allows projects to isolate their network from other projects when using the redhat/openshift\-ovs\-multitenant network plugin.
19
+
20
+
21
+.SH OPTIONS
22
+.PP
23
+\fB\-\-selector\fP=""
24
+    Label selector to filter projects. Either pass one/more projects as arguments or use this project selector
25
+
26
+
27
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
28
+.PP
29
+\fB\-\-api\-version\fP=""
30
+    DEPRECATED: The API version to use when talking to the server
31
+
32
+.PP
33
+\fB\-\-as\fP=""
34
+    Username to impersonate for the operation.
35
+
36
+.PP
37
+\fB\-\-certificate\-authority\fP=""
38
+    Path to a cert. file for the certificate authority.
39
+
40
+.PP
41
+\fB\-\-client\-certificate\fP=""
42
+    Path to a client certificate file for TLS.
43
+
44
+.PP
45
+\fB\-\-client\-key\fP=""
46
+    Path to a client key file for TLS.
47
+
48
+.PP
49
+\fB\-\-cluster\fP=""
50
+    The name of the kubeconfig cluster to use
51
+
52
+.PP
53
+\fB\-\-config\fP=""
54
+    Path to the config file to use for CLI requests.
55
+
56
+.PP
57
+\fB\-\-context\fP=""
58
+    The name of the kubeconfig context to use
59
+
60
+.PP
61
+\fB\-\-google\-json\-key\fP=""
62
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
63
+
64
+.PP
65
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
66
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
67
+
68
+.PP
69
+\fB\-\-log\-flush\-frequency\fP=0
70
+    Maximum number of seconds between log flushes
71
+
72
+.PP
73
+\fB\-\-match\-server\-version\fP=false
74
+    Require server version to match client version
75
+
76
+.PP
77
+\fB\-n\fP, \fB\-\-namespace\fP=""
78
+    If present, the namespace scope for this CLI request.
79
+
80
+.PP
81
+\fB\-\-server\fP=""
82
+    The address and port of the Kubernetes API server
83
+
84
+.PP
85
+\fB\-\-token\fP=""
86
+    Bearer token for authentication to the API server.
87
+
88
+.PP
89
+\fB\-\-user\fP=""
90
+    The name of the kubeconfig user to use
91
+
92
+
93
+.SH EXAMPLE
94
+.PP
95
+.RS
96
+
97
+.nf
98
+	# Provide isolation for project p1
99
+	oc adm pod\-network isolate\-projects <p1>
100
+
101
+	# Allow all projects with label name=top\-secret to have their own isolated project network
102
+	oc adm pod\-network isolate\-projects \-\-selector='name=top\-secret'
103
+
104
+.fi
105
+.RE
106
+
107
+
108
+.SH SEE ALSO
109
+.PP
110
+\fBoc\-adm\-pod\-network(1)\fP,
111
+
112
+
113
+.SH HISTORY
114
+.PP
115
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -87,7 +87,7 @@ This command provides common pod network operations for administrators.
87 87
 
88 88
 .SH SEE ALSO
89 89
 .PP
90
-\fBoc\-adm(1)\fP, \fBoc\-adm\-pod\-network\-join\-projects(1)\fP, \fBoc\-adm\-pod\-network\-make\-projects\-global(1)\fP,
90
+\fBoc\-adm(1)\fP, \fBoc\-adm\-pod\-network\-isolate\-projects(1)\fP, \fBoc\-adm\-pod\-network\-join\-projects(1)\fP, \fBoc\-adm\-pod\-network\-make\-projects\-global(1)\fP,
91 91
 
92 92
 
93 93
 .SH HISTORY
94 94
new file mode 100644
... ...
@@ -0,0 +1,116 @@
0
+.TH "OPENSHIFT ADMIN POD-NETWORK" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+openshift admin pod\-network isolate\-projects \- Isolate project network
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBopenshift admin pod\-network isolate\-projects\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Isolate project network
16
+
17
+.PP
18
+Allows projects to isolate their network from other projects when using the redhat/openshift\-ovs\-multitenant network plugin.
19
+
20
+
21
+.SH OPTIONS
22
+.PP
23
+\fB\-\-selector\fP=""
24
+    Label selector to filter projects. Either pass one/more projects as arguments or use this project selector
25
+
26
+
27
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
28
+.PP
29
+\fB\-\-api\-version\fP=""
30
+    DEPRECATED: The API version to use when talking to the server
31
+
32
+.PP
33
+\fB\-\-as\fP=""
34
+    Username to impersonate for the operation.
35
+
36
+.PP
37
+\fB\-\-certificate\-authority\fP=""
38
+    Path to a cert. file for the certificate authority.
39
+
40
+.PP
41
+\fB\-\-client\-certificate\fP=""
42
+    Path to a client certificate file for TLS.
43
+
44
+.PP
45
+\fB\-\-client\-key\fP=""
46
+    Path to a client key file for TLS.
47
+
48
+.PP
49
+\fB\-\-cluster\fP=""
50
+    The name of the kubeconfig cluster to use
51
+
52
+.PP
53
+\fB\-\-config\fP=""
54
+    Path to the config file to use for CLI requests.
55
+
56
+.PP
57
+\fB\-\-context\fP=""
58
+    The name of the kubeconfig context to use
59
+
60
+.PP
61
+\fB\-\-google\-json\-key\fP=""
62
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
63
+
64
+.PP
65
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
66
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
67
+
68
+.PP
69
+\fB\-\-log\-flush\-frequency\fP=0
70
+    Maximum number of seconds between log flushes
71
+
72
+.PP
73
+\fB\-\-match\-server\-version\fP=false
74
+    Require server version to match client version
75
+
76
+.PP
77
+\fB\-n\fP, \fB\-\-namespace\fP=""
78
+    If present, the namespace scope for this CLI request.
79
+
80
+.PP
81
+\fB\-\-server\fP=""
82
+    The address and port of the Kubernetes API server
83
+
84
+.PP
85
+\fB\-\-token\fP=""
86
+    Bearer token for authentication to the API server.
87
+
88
+.PP
89
+\fB\-\-user\fP=""
90
+    The name of the kubeconfig user to use
91
+
92
+
93
+.SH EXAMPLE
94
+.PP
95
+.RS
96
+
97
+.nf
98
+	# Provide isolation for project p1
99
+	openshift admin pod\-network isolate\-projects <p1>
100
+
101
+	# Allow all projects with label name=top\-secret to have their own isolated project network
102
+	openshift admin pod\-network isolate\-projects \-\-selector='name=top\-secret'
103
+
104
+.fi
105
+.RE
106
+
107
+
108
+.SH SEE ALSO
109
+.PP
110
+\fBopenshift\-admin\-pod\-network(1)\fP,
111
+
112
+
113
+.SH HISTORY
114
+.PP
115
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -87,7 +87,7 @@ This command provides common pod network operations for administrators.
87 87
 
88 88
 .SH SEE ALSO
89 89
 .PP
90
-\fBopenshift\-admin(1)\fP, \fBopenshift\-admin\-pod\-network\-join\-projects(1)\fP, \fBopenshift\-admin\-pod\-network\-make\-projects\-global(1)\fP,
90
+\fBopenshift\-admin(1)\fP, \fBopenshift\-admin\-pod\-network\-isolate\-projects(1)\fP, \fBopenshift\-admin\-pod\-network\-join\-projects(1)\fP, \fBopenshift\-admin\-pod\-network\-make\-projects\-global(1)\fP,
91 91
 
92 92
 
93 93
 .SH HISTORY
94 94
new file mode 100644
... ...
@@ -0,0 +1,116 @@
0
+.TH "OPENSHIFT CLI ADM POD-NETWORK" "1" " Openshift CLI User Manuals" "Openshift" "June 2016"  ""
1
+
2
+
3
+.SH NAME
4
+.PP
5
+openshift cli adm pod\-network isolate\-projects \- Isolate project network
6
+
7
+
8
+.SH SYNOPSIS
9
+.PP
10
+\fBopenshift cli adm pod\-network isolate\-projects\fP [OPTIONS]
11
+
12
+
13
+.SH DESCRIPTION
14
+.PP
15
+Isolate project network
16
+
17
+.PP
18
+Allows projects to isolate their network from other projects when using the redhat/openshift\-ovs\-multitenant network plugin.
19
+
20
+
21
+.SH OPTIONS
22
+.PP
23
+\fB\-\-selector\fP=""
24
+    Label selector to filter projects. Either pass one/more projects as arguments or use this project selector
25
+
26
+
27
+.SH OPTIONS INHERITED FROM PARENT COMMANDS
28
+.PP
29
+\fB\-\-api\-version\fP=""
30
+    DEPRECATED: The API version to use when talking to the server
31
+
32
+.PP
33
+\fB\-\-as\fP=""
34
+    Username to impersonate for the operation.
35
+
36
+.PP
37
+\fB\-\-certificate\-authority\fP=""
38
+    Path to a cert. file for the certificate authority.
39
+
40
+.PP
41
+\fB\-\-client\-certificate\fP=""
42
+    Path to a client certificate file for TLS.
43
+
44
+.PP
45
+\fB\-\-client\-key\fP=""
46
+    Path to a client key file for TLS.
47
+
48
+.PP
49
+\fB\-\-cluster\fP=""
50
+    The name of the kubeconfig cluster to use
51
+
52
+.PP
53
+\fB\-\-config\fP=""
54
+    Path to the config file to use for CLI requests.
55
+
56
+.PP
57
+\fB\-\-context\fP=""
58
+    The name of the kubeconfig context to use
59
+
60
+.PP
61
+\fB\-\-google\-json\-key\fP=""
62
+    The Google Cloud Platform Service Account JSON Key to use for authentication.
63
+
64
+.PP
65
+\fB\-\-insecure\-skip\-tls\-verify\fP=false
66
+    If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
67
+
68
+.PP
69
+\fB\-\-log\-flush\-frequency\fP=0
70
+    Maximum number of seconds between log flushes
71
+
72
+.PP
73
+\fB\-\-match\-server\-version\fP=false
74
+    Require server version to match client version
75
+
76
+.PP
77
+\fB\-n\fP, \fB\-\-namespace\fP=""
78
+    If present, the namespace scope for this CLI request.
79
+
80
+.PP
81
+\fB\-\-server\fP=""
82
+    The address and port of the Kubernetes API server
83
+
84
+.PP
85
+\fB\-\-token\fP=""
86
+    Bearer token for authentication to the API server.
87
+
88
+.PP
89
+\fB\-\-user\fP=""
90
+    The name of the kubeconfig user to use
91
+
92
+
93
+.SH EXAMPLE
94
+.PP
95
+.RS
96
+
97
+.nf
98
+	# Provide isolation for project p1
99
+	openshift cli adm pod\-network isolate\-projects <p1>
100
+
101
+	# Allow all projects with label name=top\-secret to have their own isolated project network
102
+	openshift cli adm pod\-network isolate\-projects \-\-selector='name=top\-secret'
103
+
104
+.fi
105
+.RE
106
+
107
+
108
+.SH SEE ALSO
109
+.PP
110
+\fBopenshift\-cli\-adm\-pod\-network(1)\fP,
111
+
112
+
113
+.SH HISTORY
114
+.PP
115
+June 2016, Ported from the Kubernetes man\-doc generator
... ...
@@ -87,7 +87,7 @@ This command provides common pod network operations for administrators.
87 87
 
88 88
 .SH SEE ALSO
89 89
 .PP
90
-\fBopenshift\-cli\-adm(1)\fP, \fBopenshift\-cli\-adm\-pod\-network\-join\-projects(1)\fP, \fBopenshift\-cli\-adm\-pod\-network\-make\-projects\-global(1)\fP,
90
+\fBopenshift\-cli\-adm(1)\fP, \fBopenshift\-cli\-adm\-pod\-network\-isolate\-projects(1)\fP, \fBopenshift\-cli\-adm\-pod\-network\-join\-projects(1)\fP, \fBopenshift\-cli\-adm\-pod\-network\-make\-projects\-global(1)\fP,
91 91
 
92 92
 
93 93
 .SH HISTORY