-
Notifications
You must be signed in to change notification settings - Fork 346
/
antctl.go
279 lines (273 loc) · 9.27 KB
/
antctl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// Copyright 2019 Antrea Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package antctl
import (
"fmt"
"reflect"
"github.com/vmware-tanzu/antrea/pkg/agent/apiserver/handlers/agentinfo"
"github.com/vmware-tanzu/antrea/pkg/agent/apiserver/handlers/ovsflows"
"github.com/vmware-tanzu/antrea/pkg/agent/apiserver/handlers/podinterface"
"github.com/vmware-tanzu/antrea/pkg/agent/openflow"
"github.com/vmware-tanzu/antrea/pkg/antctl/transform/addressgroup"
"github.com/vmware-tanzu/antrea/pkg/antctl/transform/appliedtogroup"
"github.com/vmware-tanzu/antrea/pkg/antctl/transform/controllerinfo"
"github.com/vmware-tanzu/antrea/pkg/antctl/transform/networkpolicy"
"github.com/vmware-tanzu/antrea/pkg/antctl/transform/version"
networkingv1beta1 "github.com/vmware-tanzu/antrea/pkg/apis/networking/v1beta1"
systemv1beta1 "github.com/vmware-tanzu/antrea/pkg/apis/system/v1beta1"
controllerinforest "github.com/vmware-tanzu/antrea/pkg/apiserver/registry/system/controllerinfo"
"github.com/vmware-tanzu/antrea/pkg/client/clientset/versioned/scheme"
)
// CommandList defines all commands that could be used in the antctl for both agents
// and controller. The unit test "TestCommandListValidation" ensures it to be valid.
var CommandList = &commandList{
definitions: []commandDefinition{
{
use: "version",
short: "Print version information",
long: "Print version information of antctl and ${component}",
commandGroup: flat,
controllerEndpoint: &endpoint{
resourceEndpoint: &resourceEndpoint{
resourceName: controllerinforest.ControllerInfoResourceName,
groupVersionResource: &systemv1beta1.ControllerInfoVersionResource,
},
addonTransform: version.ControllerTransform,
},
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/version",
},
addonTransform: version.AgentTransform,
},
transformedResponse: reflect.TypeOf(version.Response{}),
},
{
use: "networkpolicy",
aliases: []string{"networkpolicies", "netpol"},
short: "Print NetworkPolicies",
long: "Print NetworkPolicies in ${component}. \"namespace\" is required if \"name\" is provided.",
example: ` Get a specific NetworkPolicy
$ antctl get networkpolicy np1 -n ns1
Get the list of NetworkPolicies in a Namespace
$ antctl get networkpolicy -n ns1
Get the list of NetworkPolicies in all Namespaces
$ antctl get networkpolicy
Get the list of NetworkPolicies applied to a Pod (supported by agent only)
$ antctl get networkpolicy -p pod1 -n ns1`,
commandGroup: get,
controllerEndpoint: &endpoint{
resourceEndpoint: &resourceEndpoint{
groupVersionResource: &networkingv1beta1.NetworkPolicyVersionResource,
resourceName: "",
namespaced: true,
},
addonTransform: networkpolicy.Transform,
},
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/networkpolicies",
params: []flagInfo{
{
name: "name",
usage: "Get NetworkPolicy by name. If present, Namespace must be provided.",
arg: true,
},
{
name: "namespace",
usage: "Get Networkpolicies from specific Namespace",
shorthand: "n",
},
{
name: "pod",
usage: "Get NetworkPolicies applied to the Pod. If present, Namespace must be provided.",
shorthand: "p",
},
},
},
addonTransform: networkpolicy.Transform,
},
transformedResponse: reflect.TypeOf(networkpolicy.Response{}),
},
{
use: "appliedtogroup",
aliases: []string{"appliedtogroups", "atg"},
short: "Print appliedto groups",
long: "Print appliedto groups in ${component}",
commandGroup: get,
controllerEndpoint: &endpoint{
resourceEndpoint: &resourceEndpoint{
groupVersionResource: &networkingv1beta1.AppliedToGroupVersionResource,
},
addonTransform: appliedtogroup.Transform,
},
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/appliedtogroups",
params: []flagInfo{
{
usage: "Retrieve resource by name",
name: "name",
arg: true,
},
},
},
addonTransform: appliedtogroup.Transform,
},
transformedResponse: reflect.TypeOf(appliedtogroup.Response{}),
},
{
use: "addressgroup",
aliases: []string{"addressgroups", "ag"},
short: "Print address groups",
long: "Print address groups in ${component}",
commandGroup: get,
controllerEndpoint: &endpoint{
resourceEndpoint: &resourceEndpoint{
groupVersionResource: &networkingv1beta1.AddressGroupVersionResource,
},
addonTransform: addressgroup.Transform,
},
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/addressgroups",
params: []flagInfo{
{
usage: "Retrieve resource by name",
name: "name",
arg: true,
},
},
},
addonTransform: addressgroup.Transform,
},
transformedResponse: reflect.TypeOf(addressgroup.Response{}),
},
{
use: "controllerinfo",
aliases: []string{"controllerinfos", "ci"},
short: "Print Antrea controller's basic information",
long: "Print Antrea controller's basic information including version, deployment, NetworkPolicy controller, ControllerConditions, etc.",
controllerEndpoint: &endpoint{
resourceEndpoint: &resourceEndpoint{
resourceName: controllerinforest.ControllerInfoResourceName,
groupVersionResource: &systemv1beta1.ControllerInfoVersionResource,
},
addonTransform: controllerinfo.Transform,
},
commandGroup: get,
transformedResponse: reflect.TypeOf(controllerinfo.Response{}),
},
{
use: "agentinfo",
aliases: []string{"agentinfos", "ai"},
short: "Print agent's basic information",
long: "Print agent's basic information including version, deployment, Node subnet, OVS info, AgentConditions, etc.",
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/agentinfo",
outputType: single,
},
},
commandGroup: get,
transformedResponse: reflect.TypeOf(agentinfo.AntreaAgentInfoResponse{}),
},
{
use: "podinterface",
aliases: []string{"podinterfaces", "pi"},
short: "Print Pod's network interface information",
long: "Print information about the network interface(s) created by the Antrea agent for the specified Pod.",
example: ` Get a pod-interface
$ antctl get podinterface pod1 -n ns1
Get the list of podinterfaces in a Namespace
$ antctl get podinterface -n ns1
Get the list of podinterfaces whose names match in all Namespaces
$ antctl get podinterface pod1
Get the list of podinterfaces in all Namespaces
$ antctl get podinterface`,
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/podinterfaces",
params: []flagInfo{
{
name: "name",
usage: "Retrieve Pod interface by name. If present, Namespace must be provided.",
arg: true,
},
{
name: "namespace",
usage: "Get Pod interfaces from specific Namespace",
shorthand: "n",
},
},
outputType: multiple,
},
},
commandGroup: get,
transformedResponse: reflect.TypeOf(podinterface.Response{}),
},
{
use: "ovsflows",
aliases: []string{"of"},
short: "Dump OVS flows",
long: "Dump all the OVS flows or the flows installed for the specified entity.",
example: ` Dump all OVS flows
$ antctl get ovsflows
Dump OVS flows of a local Pod
$ antctl get ovsflows -p pod1 -n ns1
Dump OVS flows of a NetworkPolicy
$ antctl get ovsflows --networkpolicy np1 -n ns1
Dump OVS flows of a flow Table
$ antctl get ovsflows -t IngressRule
Antrea OVS Flow Tables:` + generateFlowTableHelpMsg(),
agentEndpoint: &endpoint{
nonResourceEndpoint: &nonResourceEndpoint{
path: "/ovsflows",
params: []flagInfo{
{
name: "namespace",
usage: "Namespace of the entity",
shorthand: "n",
},
{
name: "pod",
usage: "Name of a local Pod. If present, Namespace must be provided.",
shorthand: "p",
},
{
name: "networkpolicy",
usage: "NetworkPolicy name. If present, Namespace must be provided.",
},
{
name: "table",
usage: "Antrea OVS flow table name or number",
shorthand: "T",
},
},
outputType: multiple,
},
},
commandGroup: get,
transformedResponse: reflect.TypeOf(ovsflows.Response{}),
},
},
codec: scheme.Codecs,
}
func generateFlowTableHelpMsg() string {
msg := ""
for _, t := range openflow.FlowTables {
msg += fmt.Sprintf("\n %d\t%s", uint32(t.Number), t.Name)
}
return msg
}