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

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

# Copyright 2013 Hewlett-Packard Development Company, L.P. 

# 

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

""" 

Base classes for storage engines 

""" 

 

import abc 

 

from oslo_config import cfg 

from oslo_db import api as db_api 

import six 

 

 

_BACKEND_MAPPING = {'sqlalchemy': 'magnum.db.sqlalchemy.api'} 

IMPL = db_api.DBAPI.from_config(cfg.CONF, backend_mapping=_BACKEND_MAPPING, 

                                lazy=True) 

 

 

def get_instance(): 

    """Return a DB API instance.""" 

    return IMPL 

 

 

@six.add_metaclass(abc.ABCMeta) 

class Connection(object): 

    """Base class for storage system connections.""" 

 

exit    @abc.abstractmethod 

    def __init__(self): 

        """Constructor.""" 

 

exit    @abc.abstractmethod 

    def get_bay_list(self, context, columns=None, filters=None, limit=None, 

                     marker=None, sort_key=None, sort_dir=None): 

        """Get specific columns for matching bays. 

 

        Return a list of the specified columns for all bays that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of bays to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_bay(self, values): 

        """Create a new bay. 

 

        :param values: A dict containing several items used to identify 

                       and track the bay, and several dicts which are passed 

                       into the Drivers when managing this bay. For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A bay. 

        """ 

 

exit    @abc.abstractmethod 

    def get_bay_by_id(self, context, bay_id): 

        """Return a bay. 

 

        :param context: The security context 

        :param bay_id: The id of a bay. 

        :returns: A bay. 

        """ 

 

exit    @abc.abstractmethod 

    def get_bay_by_uuid(self, context, bay_uuid): 

        """Return a bay. 

 

        :param context: The security context 

        :param bay_uuid: The uuid of a bay. 

        :returns: A bay. 

        """ 

 

exit    @abc.abstractmethod 

    def get_bay_by_name(self, context, bay_name): 

        """Return a bay. 

 

        :param context: The security context 

        :param bay_name: The name of a bay. 

        :returns: A bay. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_bay(self, bay_id): 

        """Destroy a bay and all associated interfaces. 

 

        :param bay_id: The id or uuid of a bay. 

        """ 

 

exit    @abc.abstractmethod 

    def update_bay(self, bay_id, values): 

        """Update properties of a bay. 

 

        :param bay_id: The id or uuid of a bay. 

        :returns: A bay. 

        :raises: BayNotFound 

        """ 

 

exit    @abc.abstractmethod 

    def create_bay_lock(self, bay_uuid, conductor_id): 

        """Create a new baylock. 

 

        This method will fail if the bay has already been locked. 

 

        :param bay_uuid: The uuid of a bay. 

        :param conductor_id: The id of a conductor. 

        :returns: None if success. 

                  Otherwise, the id of the conductor that locks the bay. 

        """ 

 

exit    @abc.abstractmethod 

    def steal_bay_lock(self, bay_uuid, old_conductor_id, new_conductor_id): 

        """Steal lock of a bay. 

 

        Lock the bay with new_conductor_id if the bay is currently locked by 

        old_conductor_id. 

 

        :param bay_uuid: The uuid of a bay. 

        :param old_conductor_id: The id of the old conductor. 

        :param new_conductor_id: The id of the new conductor. 

        :returns: None if success. True if the bay is not locked. 

                  Otherwise, the id of the conductor that locks the bay. 

        """ 

 

exit    @abc.abstractmethod 

    def release_bay_lock(self, bay_uuid, conductor_id): 

        """Release lock of a bay. 

 

        :param bay_uuid: The uuid of a bay. 

        :param conductor_id: The id of a conductor. 

        :returns: None if success. True otherwise. 

        """ 

 

exit    @abc.abstractmethod 

    def get_baymodel_list(self, context, columns=None, filters=None, 

                          limit=None, marker=None, sort_key=None, 

                          sort_dir=None): 

        """Get specific columns for matching baymodels. 

 

        Return a list of the specified columns for all baymodels that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of baymodels to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_baymodel(self, values): 

        """Create a new baymodel. 

 

        :param values: A dict containing several items used to identify 

                       and track the baymodel, and several dicts which are 

                       passed into the Drivers when managing this baymodel. 

                       For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A baymodel. 

        """ 

 

exit    @abc.abstractmethod 

    def get_baymodel_by_id(self, context, baymodel_id): 

        """Return a baymodel. 

 

        :param context: The security context 

        :param baymodel_id: The id of a baymodel. 

        :returns: A baymodel. 

        """ 

 

exit    @abc.abstractmethod 

    def get_baymodel_by_uuid(self, context, baymodel_uuid): 

        """Return a baymodel. 

 

        :param context: The security context 

        :param baymodel_uuid: The uuid of a baymodel. 

        :returns: A baymodel. 

        """ 

 

exit    @abc.abstractmethod 

    def get_baymodel_by_name(self, context, baymodel_name): 

        """Return a baymodel. 

 

        :param context: The security context 

        :param baymodel_name: The name of a baymodel. 

        :returns: A baymodel. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_baymodel(self, baymodel_id): 

        """Destroy a baymodel and all associated interfaces. 

 

        :param baymodel_id: The id or uuid of a baymodel. 

        """ 

 

exit    @abc.abstractmethod 

    def update_baymodel(self, baymodel_id, values): 

        """Update properties of a baymodel. 

 

        :param baymodel_id: The id or uuid of a baymodel. 

        :returns: A baymodel. 

        :raises: BayModelNotFound 

        """ 

 

exit    @abc.abstractmethod 

    def get_container_list(self, context, columns=None, filters=None, 

                           limit=None, marker=None, sort_key=None, 

                           sort_dir=None): 

        """Get specific columns for matching containers. 

 

        Return a list of the specified columns for all containers that match 

        the specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of containers to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_container(self, values): 

        """Create a new container. 

 

        :param values: A dict containing several items used to identify 

                       and track the container, and several dicts which are 

                       passed 

                       into the Drivers when managing this container. For 

                       example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A container. 

        """ 

 

exit    @abc.abstractmethod 

    def get_container_by_id(self, context, container_id): 

        """Return a container. 

 

        :param context: The security context 

        :param container_id: The id of a container. 

        :returns: A container. 

        """ 

 

exit    @abc.abstractmethod 

    def get_container_by_uuid(self, context, container_uuid): 

        """Return a container. 

 

        :param context: The security context 

        :param container_uuid: The uuid of a container. 

        :returns: A container. 

        """ 

 

exit    @abc.abstractmethod 

    def get_container_by_name(self, context, container_name): 

        """Return a container. 

 

        :param context: The security context 

        :param container_name: The name of a container. 

        :returns: A container. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_container(self, container_id): 

        """Destroy a container and all associated interfaces. 

 

        :param container_id: The id or uuid of a container. 

        """ 

 

exit    @abc.abstractmethod 

    def update_container(self, container_id, values): 

        """Update properties of a container. 

 

        :param container_id: The id or uuid of a container. 

        :returns: A container. 

        :raises: BayNotFound 

        """ 

 

exit    @abc.abstractmethod 

    def get_node_list(self, context, columns=None, filters=None, limit=None, 

                     marker=None, sort_key=None, sort_dir=None): 

        """Get specific columns for matching nodes. 

 

        Return a list of the specified columns for all nodes that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of nodes to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_node(self, values): 

        """Create a new node. 

 

        :param values: A dict containing several items used to identify 

                       and track the node, and several dicts which are passed 

                       into the Drivers when managing this node. For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A node. 

        """ 

 

exit    @abc.abstractmethod 

    def get_node_by_id(self, context, node_id): 

        """Return a node. 

 

        :param context: The security context 

        :param node_id: The id of a node. 

        :returns: A node. 

        """ 

 

exit    @abc.abstractmethod 

    def get_node_by_uuid(self, context, node_uuid): 

        """Return a node. 

 

        :param context: The security context 

        :param node_uuid: The uuid of a node. 

        :returns: A node. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_node(self, node_id): 

        """Destroy a node and all associated interfaces. 

 

        :param node_id: The id or uuid of a node. 

        """ 

 

exit    @abc.abstractmethod 

    def update_node(self, node_id, values): 

        """Update properties of a node. 

 

        :param node_id: The id or uuid of a node. 

        :returns: A node. 

        :raises: NodeAssociated 

        :raises: NodeNotFound 

        """ 

exit    @abc.abstractmethod 

    def get_pod_list(self, context, columns=None, filters=None, limit=None, 

                     marker=None, sort_key=None, sort_dir=None): 

        """Get specific columns for matching pods. 

 

        Return a list of the specified columns for all pods that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of pods to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_pod(self, values): 

        """Create a new pod. 

 

        :param values: A dict containing several items used to identify 

                       and track the pod, and several dicts which are passed 

                       into the Drivers when managing this pod. For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A pod. 

        """ 

 

exit    @abc.abstractmethod 

    def get_pod_by_id(self, context, pod_id): 

        """Return a pod. 

 

        :param context: The security context 

        :param pod_id: The id of a pod. 

        :returns: A pod. 

        """ 

 

exit    @abc.abstractmethod 

    def get_pod_by_uuid(self, context, pod_uuid): 

        """Return a pod. 

 

        :param context: The security context 

        :param pod_uuid: The uuid of a pod. 

        :returns: A pod. 

        """ 

 

exit    @abc.abstractmethod 

    def get_pod_by_name(self, pod_name): 

        """Return a pod. 

 

        :param pod_name: The name of a pod. 

        :returns: A pod. 

        """ 

 

exit    @abc.abstractmethod 

    def get_pods_by_bay_uuid(self, bay_uuid): 

        """List all the pods for a given bay. 

 

        :param bay_uuid: The uuid of a bay. 

        :returns: A list of pods. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_pod(self, pod_id): 

        """Destroy a pod and all associated interfaces. 

 

        :param pod_id: The id or uuid of a pod. 

        """ 

 

exit    @abc.abstractmethod 

    def update_pod(self, pod_id, values): 

        """Update properties of a pod. 

 

        :param pod_id: The id or uuid of a pod. 

        :returns: A pod. 

        :raises: BayNotFound 

        """ 

 

exit    @abc.abstractmethod 

    def get_service_list(self, context, columns=None, filters=None, limit=None, 

                     marker=None, sort_key=None, sort_dir=None): 

        """Get specific columns for matching services. 

 

        Return a list of the specified columns for all services that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of services to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def create_service(self, values): 

        """Create a new service. 

 

        :param values: A dict containing several items used to identify 

                       and track the service, and several dicts which are 

                       passed into the Drivers when managing this service. 

                       For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'type': 'virt' 

                        } 

        :returns: A service. 

        """ 

 

exit    @abc.abstractmethod 

    def get_service_by_id(self, context, service_id): 

        """Return a service. 

 

        :param context: The security context 

        :param service_id: The id of a service. 

        :returns: A service. 

        """ 

 

exit    @abc.abstractmethod 

    def get_service_by_uuid(self, context, service_uuid): 

        """Return a service. 

 

        :param context: The security context 

        :param service_uuid: The uuid of a service. 

        :returns: A service. 

        """ 

 

exit    @abc.abstractmethod 

    def get_services_by_bay_uuid(self, bay_uuid): 

        """List all the services for a given bay. 

 

        :param bay_uuid: The uuid of a bay. 

        :returns: A list of services. 

        """ 

 

exit    @abc.abstractmethod 

    def get_service_by_name(self, bay_name): 

        """Return a service. 

 

        :param context: The security context 

        :param service_name: The name of a service 

        :returns: A service. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_service(self, service_id): 

        """Destroy a service and all associated interfaces. 

 

        :param service_id: The id or uuid of a service. 

        """ 

 

exit    @abc.abstractmethod 

    def update_service(self, service_id, values): 

        """Update properties of a service. 

 

        :param service_id: The id or uuid of a service. 

        :returns: A service. 

        :raises: BayNotFound 

        """ 

 

exit    @abc.abstractmethod 

    def get_rc_list(self, context, columns=None, filters=None, limit=None, 

                     marker=None, sort_key=None, sort_dir=None): 

        """Get specific columns for matching ReplicationController. 

 

        Return a list of the specified columns for all rcs that match the 

        specified filters. 

 

        :param context: The security context 

        :param columns: List of column names to return. 

                        Defaults to 'id' column when columns == None. 

        :param filters: Filters to apply. Defaults to None. 

 

        :param limit: Maximum number of pods to return. 

        :param marker: the last item of the previous page; we return the next 

                       result set. 

        :param sort_key: Attribute by which results should be sorted. 

        :param sort_dir: direction in which results should be sorted. 

                         (asc, desc) 

        :returns: A list of tuples of the specified columns. 

        """ 

 

exit    @abc.abstractmethod 

    def get_rcs_by_bay_uuid(self, bay_uuid): 

        """List all the ReplicationControllers for a given bay. 

 

        :param bay_uuid: The uuid of a bay. 

        :returns: A list of ReplicationControllers. 

        """ 

 

exit    @abc.abstractmethod 

    def create_rc(self, values): 

        """Create a new ReplicationController. 

 

        :param values: A dict containing several items used to identify 

                       and track the rc, and several dicts which are passed 

                       into the Drivers when managing this pod. For example: 

 

                       :: 

 

                        { 

                         'uuid': utils.generate_uuid(), 

                         'name': 'example', 

                         'images': '["myimage"]' 

                        } 

        :returns: A ReplicationController. 

        """ 

 

exit    @abc.abstractmethod 

    def get_rc_by_id(self, context, rc_id): 

        """Return a ReplicationController. 

 

        :param context: The security context 

        :param rc_id: The id of a rc. 

        :returns: A ReplicationController. 

        """ 

 

exit    @abc.abstractmethod 

    def get_rc_by_uuid(self, context, rc_uuid): 

        """Return a ReplicationController. 

 

        :param context: The security context 

        :param rc_uuid: The uuid of a ReplicationController. 

        :returns: A ReplicationController. 

        """ 

 

exit    @abc.abstractmethod 

    def get_rc_by_name(self, rc_name): 

        """Return a ReplicationController. 

 

        :param rc_name: The name of a ReplicationController. 

        :returns: A ReplicationController. 

        """ 

 

exit    @abc.abstractmethod 

    def destroy_rc(self, rc_id): 

        """Destroy a ReplicationController and all associated interfaces. 

 

        :param rc_id: The id or uuid of a ReplicationController. 

        """ 

 

exit    @abc.abstractmethod 

    def update_rc(self, rc_id, values): 

        """Update properties of a ReplicationController. 

 

        :param rc_id: The id or uuid of a ReplicationController. 

        :returns: A ReplicationController. 

        """