Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

# 

#    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. 

 

import datetime 

 

import pecan 

from pecan import rest 

import wsme 

from wsme import types as wtypes 

import wsmeext.pecan as wsme_pecan 

 

from magnum.api.controllers import link 

from magnum.api.controllers.v1 import base as v1_base 

from magnum.api.controllers.v1 import collection 

from magnum.api.controllers.v1 import types 

from magnum.api.controllers.v1 import utils as api_utils 

from magnum.common import exception 

from magnum.common import k8s_manifest 

from magnum import objects 

 

 

class PodPatchType(v1_base.K8sPatchType): 

    pass 

 

 

class Pod(v1_base.K8sResourceBase): 

    """API representation of a pod. 

 

    This class enforces type checking and value constraints, and converts 

    between the internal object model and the API representation of a pod. 

    """ 

 

    uuid = types.uuid 

    """Unique UUID for this pod""" 

 

    desc = wtypes.text 

    """Description of this pod""" 

 

    images = [wtypes.text] 

    """A list of images used by containers in this pod.""" 

 

    status = wtypes.text 

    """Staus of this pod """ 

 

    links = wsme.wsattr([link.Link], readonly=True) 

    """A list containing a self link and associated pod links""" 

 

    def __init__(self, **kwargs): 

        super(Pod, self).__init__() 

 

        self.fields = [] 

        for field in objects.Pod.fields: 

            # Skip fields we do not expose. 

            if not hasattr(self, field): 

                continue 

            self.fields.append(field) 

            setattr(self, field, kwargs.get(field, wtypes.Unset)) 

 

    @staticmethod 

    def _convert_with_links(pod, url, expand=True): 

        if not expand: 

            pod.unset_fields_except(['uuid', 'name', 'desc', 'bay_uuid', 

                                     'images', 'labels', 'status']) 

 

        pod.links = [link.Link.make_link('self', url, 

                                         'pods', pod.uuid), 

                     link.Link.make_link('bookmark', url, 

                                         'pods', pod.uuid, 

                                         bookmark=True) 

                     ] 

        return pod 

 

    @classmethod 

    def convert_with_links(cls, rpc_pod, expand=True): 

        pod = Pod(**rpc_pod.as_dict()) 

        return cls._convert_with_links(pod, pecan.request.host_url, expand) 

 

    @classmethod 

    def sample(cls, expand=True): 

        sample = cls(uuid='f978db47-9a37-4e9f-8572-804a10abc0aa', 

                     name='MyPod', 

                     desc='Pod - Description', 

                     bay_uuid='7ae81bb3-dec3-4289-8d6c-da80bd8001ae', 

                     images=['MyImage'], 

                     labels={'name': 'foo'}, 

                     status='Running', 

                     manifest_url='file:///tmp/rc.yaml', 

                     manifest = '''{ 

                         "metadata": { 

                             "name": "name_of_pod" 

                         }, 

                         "spec": { 

                             "containers": [ 

                                 { 

                                     "name": "test", 

                                     "image": "test" 

                                 } 

                             ] 

                         } 

                     }''', 

                     created_at=datetime.datetime.utcnow(), 

                     updated_at=datetime.datetime.utcnow()) 

        return cls._convert_with_links(sample, 'http://localhost:9511', expand) 

 

    def parse_manifest(self): 

        try: 

            manifest = k8s_manifest.parse(self._get_manifest()) 

        except ValueError as e: 

            raise exception.InvalidParameterValue(message=str(e)) 

        try: 

            self.name = manifest["metadata"]["name"] 

        except (KeyError, TypeError): 

            raise exception.InvalidParameterValue( 

                "Field metadata['name'] can't be empty in manifest.") 

        images = [] 

        try: 

            for container in manifest["spec"]["containers"]: 

                images.append(container["image"]) 

            self.images = images 

        except (KeyError, TypeError): 

            raise exception.InvalidParameterValue( 

                "Field spec['containers'] can't be empty in manifest.") 

134        if "labels" in manifest["metadata"]: 

            self.labels = manifest["metadata"]["labels"] 

 

 

class PodCollection(collection.Collection): 

    """API representation of a collection of pods.""" 

 

    pods = [Pod] 

    """A list containing pods objects""" 

 

    def __init__(self, **kwargs): 

        self._type = 'pods' 

 

    @staticmethod 

    def convert_with_links(rpc_pods, limit, url=None, expand=False, **kwargs): 

        collection = PodCollection() 

        collection.pods = [Pod.convert_with_links(p, expand) 

                           for p in rpc_pods] 

        collection.next = collection.get_next(limit, url=url, **kwargs) 

        return collection 

 

    @classmethod 

    def sample(cls): 

        sample = cls() 

        sample.pods = [Pod.sample(expand=False)] 

        return sample 

 

 

class PodsController(rest.RestController): 

    """REST controller for Pods.""" 

 

    def __init__(self): 

        super(PodsController, self).__init__() 

 

    from_pods = False 

    """A flag to indicate if the requests to this controller are coming 

    from the top-level resource Pods.""" 

 

    _custom_actions = { 

        'detail': ['GET'], 

    } 

 

    def _get_pods_collection(self, marker, limit, 

                             sort_key, sort_dir, expand=False, 

                             resource_url=None): 

 

        limit = api_utils.validate_limit(limit) 

        sort_dir = api_utils.validate_sort_dir(sort_dir) 

 

        marker_obj = None 

184        if marker: 

            marker_obj = objects.Pod.get_by_uuid(pecan.request.context, 

                                                 marker) 

 

        pods = pecan.request.rpcapi.pod_list(pecan.request.context, limit, 

                                         marker_obj, sort_key=sort_key, 

                                         sort_dir=sort_dir) 

 

        return PodCollection.convert_with_links(pods, limit, 

                                                url=resource_url, 

                                                expand=expand, 

                                                sort_key=sort_key, 

                                                sort_dir=sort_dir) 

 

    @wsme_pecan.wsexpose(PodCollection, types.uuid, 

                         types.uuid, int, wtypes.text, wtypes.text) 

    def get_all(self, pod_uuid=None, marker=None, limit=None, 

                sort_key='id', sort_dir='asc'): 

        """Retrieve a list of pods. 

 

        :param marker: pagination marker for large data sets. 

        :param limit: maximum number of resources to return in a single result. 

        :param sort_key: column to sort results by. Default: id. 

        :param sort_dir: direction to sort. "asc" or "desc". Default: asc. 

        """ 

        return self._get_pods_collection(marker, limit, sort_key, 

                                         sort_dir) 

 

    @wsme_pecan.wsexpose(PodCollection, types.uuid, 

                         types.uuid, int, wtypes.text, wtypes.text) 

    def detail(self, pod_uuid=None, marker=None, limit=None, 

               sort_key='id', sort_dir='asc'): 

        """Retrieve a list of pods with detail. 

 

        :param pod_uuid: UUID of a pod, to get only pods for that pod. 

        :param marker: pagination marker for large data sets. 

        :param limit: maximum number of resources to return in a single result. 

        :param sort_key: column to sort results by. Default: id. 

        :param sort_dir: direction to sort. "asc" or "desc". Default: asc. 

        """ 

        # NOTE(lucasagomes): /detail should only work agaist collections 

        parent = pecan.request.path.split('/')[:-1][-1] 

        if parent != "pods": 

            raise exception.HTTPNotFound 

 

        expand = True 

        resource_url = '/'.join(['pods', 'detail']) 

        return self._get_pods_collection(marker, limit, 

                                         sort_key, sort_dir, expand, 

                                         resource_url) 

 

    @wsme_pecan.wsexpose(Pod, types.uuid_or_name) 

    def get_one(self, pod_ident): 

        """Retrieve information about the given pod. 

 

        :param pod_ident: UUID of a pod or logical name of the pod. 

        """ 

241        if self.from_pods: 

            raise exception.OperationNotPermitted 

 

        rpc_pod = api_utils.get_rpc_resource('Pod', pod_ident) 

 

        return Pod.convert_with_links(rpc_pod) 

 

    @wsme_pecan.wsexpose(Pod, body=Pod, status_code=201) 

    def post(self, pod): 

        """Create a new pod. 

 

        :param pod: a pod within the request body. 

        """ 

254        if self.from_pods: 

            raise exception.OperationNotPermitted 

 

        pod.parse_manifest() 

        pod_dict = pod.as_dict() 

        context = pecan.request.context 

        auth_token = context.auth_token_info['token'] 

        pod_dict['project_id'] = auth_token['project']['id'] 

        pod_dict['user_id'] = auth_token['user']['id'] 

        pod_obj = objects.Pod(context, **pod_dict) 

        new_pod = pecan.request.rpcapi.pod_create(pod_obj) 

        # Set the HTTP Location Header 

        pecan.response.location = link.build_url('pods', new_pod.uuid) 

        return Pod.convert_with_links(new_pod) 

 

    @wsme.validate(types.uuid, [PodPatchType]) 

    @wsme_pecan.wsexpose(Pod, types.uuid_or_name, body=[PodPatchType]) 

    def patch(self, pod_ident, patch): 

        """Update an existing pod. 

 

        :param pod_ident: UUID or logical name of a pod. 

        :param patch: a json PATCH document to apply to this pod. 

        """ 

277        if self.from_pods: 

            raise exception.OperationNotPermitted 

 

        rpc_pod = api_utils.get_rpc_resource('Pod', pod_ident) 

        # Init manifest and manifest_url field because we don't store them 

        # in database. 

        rpc_pod['manifest'] = None 

        rpc_pod['manifest_url'] = None 

        try: 

            pod_dict = rpc_pod.as_dict() 

            pod = Pod(**api_utils.apply_jsonpatch(pod_dict, patch)) 

            if pod.manifest or pod.manifest_url: 

                pod.parse_manifest() 

        except api_utils.JSONPATCH_EXCEPTIONS as e: 

            raise exception.PatchError(patch=patch, reason=e) 

 

        # Update only the fields that have changed 

        for field in objects.Pod.fields: 

            try: 

                patch_val = getattr(pod, field) 

            except AttributeError: 

                # Ignore fields that aren't exposed in the API 

                continue 

            if patch_val == wtypes.Unset: 

                patch_val = None 

            if rpc_pod[field] != patch_val: 

                rpc_pod[field] = patch_val 

 

        if pod.manifest or pod.manifest_url: 

            pecan.request.rpcapi.pod_update(rpc_pod) 

        else: 

            rpc_pod.save() 

        return Pod.convert_with_links(rpc_pod) 

 

    @wsme_pecan.wsexpose(None, types.uuid_or_name, status_code=204) 

    def delete(self, pod_ident): 

        """Delete a pod. 

 

        :param pod_ident: UUID of a pod or logical name of the pod. 

        """ 

317        if self.from_pods: 

            raise exception.OperationNotPermitted 

 

        rpc_pod = api_utils.get_rpc_resource('Pod', pod_ident) 

 

        pecan.request.rpcapi.pod_delete(rpc_pod.uuid)