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
|
##
## Copyright (c) 2019 Intel Corporation
##
## 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.
##
from os import path
import time, yaml
import logging
from kubernetes import client, config
from rapid_sshclient import SSHClient
class Pod:
"""Class which represents test pods.
For example with traffic gen, forward/swap applications, etc
"""
k8s_CoreV1Api = None
_log = None
_name = "pod"
_namespace = "default"
_nodeSelector_hostname = None
_spec_filename = None
_last_status = None
_id = None
_admin_ip = None
_dp_ip = None
_dp_subnet = None
_ssh_client = None
_sriov_vf = None
_sriov_vf_mac = None
def __init__(self, name, namespace = "default", logger_name = "k8srapid"):
self._log = logging.getLogger(logger_name)
self._name = name
self._namespace = namespace
self._ssh_client = SSHClient(logger_name = logger_name)
self.qat_vf = []
def __del__(self):
"""Destroy POD. Do a cleanup.
"""
if self._ssh_client is not None:
self._ssh_client.disconnect()
def create_from_yaml(self):
"""Load POD description from yaml file.
"""
with open(path.join(path.dirname(__file__),
self._spec_filename)) as yaml_file:
self.body = yaml.safe_load(yaml_file)
self.body["metadata"]["name"] = self._name
if (self._nodeSelector_hostname is not None):
if ("nodeSelector" not in self.body["spec"]):
self.body["spec"]["nodeSelector"] = {}
self.body["spec"]["nodeSelector"]["kubernetes.io/hostname"] = \
self._nodeSelector_hostname
self._log.debug("Creating POD, body:\n%s" % self.body)
try:
self.k8s_CoreV1Api.create_namespaced_pod(body = self.body,
namespace = self._namespace)
except client.rest.ApiException as e:
self._log.error("Couldn't create POD %s!\n%s\n" % (self._name,
e))
def terminate(self):
"""Terminate POD. Close SSH connection.
"""
if self._ssh_client is not None:
self._ssh_client.disconnect()
try:
self.k8s_CoreV1Api.delete_namespaced_pod(name = self._name,
namespace = self._namespace)
except client.rest.ApiException as e:
if e.reason != "Not Found":
self._log.error("Couldn't delete POD %s!\n%s\n" % (self._name, e.reason))
def update_admin_ip(self):
"""Check for admin IP address assigned by k8s.
"""
try:
pod = self.k8s_CoreV1Api.read_namespaced_pod_status(name = self._name, namespace = self._namespace)
self._admin_ip = pod.status.pod_ip
except client.rest.ApiException as e:
self._log.error("Couldn't update POD %s admin IP!\n%s\n" % (self._name, e))
def wait_for_start(self):
"""Wait for POD to start.
"""
self._log.info("Waiting for POD %s to start..." % self._name)
while True:
self.get_status()
if (self._last_status == "Running" or self._last_status == "Failed"
or self._last_status == "Unknown"):
break
else:
time.sleep(3)
self.update_admin_ip()
return self._last_status
def ssh_run_cmd(self, cmd):
"""Execute command for POD via SSH connection.
SSH credentials should be configured before use of this function.
"""
self._ssh_client.run_cmd(cmd)
def get_name(self):
return self._name
def get_admin_ip(self):
return self._admin_ip
def get_dp_ip(self):
return self._dp_ip
def get_dp_subnet(self):
return self._dp_subnet
def get_dp_mac(self):
return self._sriov_vf_mac
def get_dp_pci_dev(self):
return self._sriov_vf
def get_qat_pci_dev(self):
return self.qat_vf
def get_id(self):
return self._id
def get_status(self):
"""Get current status fro the pod.
"""
try:
pod = self.k8s_CoreV1Api.read_namespaced_pod_status(name = self._name,
namespace = self._namespace)
except client.rest.ApiException as e:
self._log.error("Couldn't read POD %s status!\n%s\n" % (self._name, e))
self._last_status = pod.status.phase
return self._last_status
def get_qat_dev(self):
"""Get qat devices if any, assigned by k8s QAT device plugin.
"""
self._log.info("Checking assigned QAT VF for POD %s" % self._name)
ret = self._ssh_client.run_cmd("cat /opt/rapid/k8s_qat_device_plugin_envs")
if ret != 0:
self._log.error("Failed to check assigned QAT VF!"
"Error %s" % self._ssh_client.get_error())
return -1
cmd_output = self._ssh_client.get_output().decode("utf-8").rstrip()
if cmd_output:
self._log.debug("Before: Using QAT VF %s" % self.qat_vf)
self._log.debug("Environment variable %s" % cmd_output)
for line in cmd_output.splitlines():
self.qat_vf.append(line.split("=")[1])
self._log.debug("Using QAT VF %s" % self.qat_vf)
else:
self._log.debug("No QAT devices for this pod")
self.qat_vf = None
def get_sriov_dev_mac(self):
"""Get assigned by k8s SRIOV network device plugin SRIOV VF devices.
Return 0 in case of sucessfull configuration.
Otherwise return -1.
"""
self._log.info("Checking assigned SRIOV VF for POD %s" % self._name)
ret = self._ssh_client.run_cmd("cat /opt/rapid/k8s_sriov_device_plugin_envs")
if ret != 0:
self._log.error("Failed to check assigned SRIOV VF!"
"Error %s" % self._ssh_client.get_error())
return -1
cmd_output = self._ssh_client.get_output().decode("utf-8").rstrip()
self._log.debug("Environment variable %s" % cmd_output)
# Parse environment variable
cmd_output = cmd_output.split("=")[1]
self._sriov_vf = cmd_output.split(",")[0]
self._log.debug("Using first SRIOV VF %s" % self._sriov_vf)
# find DPDK version
self._log.info("Checking DPDK version for POD %s" % self._name)
ret = self._ssh_client.run_cmd("cat /opt/rapid/dpdk_version")
if ret != 0:
self._log.error("Failed to check DPDK version"
"Error %s" % self._ssh_client.get_error())
return -1
dpdk_version = self._ssh_client.get_output().decode("utf-8").rstrip()
self._log.debug("DPDK version %s" % dpdk_version)
if (dpdk_version >= '20.11.0'):
allow_parameter = 'allow'
else:
allow_parameter = 'pci-whitelist'
self._log.info("Getting MAC address for assigned SRIOV VF %s" % \
self._sriov_vf)
self._ssh_client.run_cmd("sudo /opt/rapid/port_info_app -n 4 \
--{} {}".format(allow_parameter, self._sriov_vf))
if ret != 0:
self._log.error("Failed to get MAC address!"
"Error %s" % self._ssh_client.get_error())
return -1
# Parse MAC address
cmd_output = self._ssh_client.get_output().decode("utf-8").rstrip()
self._log.debug(cmd_output)
cmd_output = cmd_output.splitlines()
for line in cmd_output:
if line.startswith("Port 0 MAC: "):
self._sriov_vf_mac = line[12:]
self._log.debug("MAC %s" % self._sriov_vf_mac)
def set_dp_ip(self, dp_ip):
self._dp_ip = dp_ip
def set_dp_subnet(self, dp_subnet):
self._dp_subnet = dp_subnet
def set_id(self, pod_id):
self._id = pod_id
def set_nodeselector(self, hostname):
"""Set hostname on which POD will be executed.
"""
self._nodeSelector_hostname = hostname
def set_spec_file_name(self, file_name):
"""Set pod spec filename.
"""
self._spec_filename = file_name
def set_ssh_credentials(self, user, rsa_private_key):
"""Set SSH credentials for the SSH connection to the POD.
"""
self.update_admin_ip()
self._ssh_client.set_credentials(ip = self._admin_ip,
user = user,
rsa_private_key = rsa_private_key)
|
