File: cluster.go

package info (click to toggle)
golang-github-vmware-govmomi 0.24.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 11,840 kB
  • sloc: sh: 2,285; lisp: 1,560; ruby: 948; xml: 139; makefile: 54
file content (112 lines) | stat: -rw-r--r-- 3,845 bytes parent folder | download | duplicates (3)
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
/*
Copyright (c) 2020 VMware, Inc. All Rights Reserved.

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 cluster

import (
	"context"
	"net/http"
	"path"

	"github.com/vmware/govmomi/vapi/rest"
	"github.com/vmware/govmomi/vim25/mo"
	"github.com/vmware/govmomi/vim25/types"

	"github.com/vmware/govmomi/vapi/cluster/internal"
)

// Manager extends rest.Client, adding cluster related methods.
type Manager struct {
	*rest.Client
}

// NewManager creates a new Manager instance with the given client.
func NewManager(client *rest.Client) *Manager {
	return &Manager{
		Client: client,
	}
}

// CreateModule creates a new module in a vCenter cluster.
func (c *Manager) CreateModule(ctx context.Context, ref mo.Reference) (string, error) {
	var s internal.CreateModule
	s.Spec.ID = ref.Reference().Value

	url := c.Resource(internal.ModulesPath)
	var res string
	return res, c.Do(ctx, url.Request(http.MethodPost, s), &res)
}

// DeleteModule deletes a specific module.
func (c *Manager) DeleteModule(ctx context.Context, id string) error {
	url := c.Resource(internal.ModulesPath + "/" + id)
	return c.Do(ctx, url.Request(http.MethodDelete), nil)
}

// ModuleSummary contains commonly used information about a module in a vCenter cluster.
type ModuleSummary struct {
	Cluster string `json:"cluster"`
	Module  string `json:"module"`
}

// ModuleSummaryList is used to JSON encode/decode a ModuleSummary.
type ModuleSummaryList struct {
	Summaries []ModuleSummary `json:"summaries"`
}

// ListModules returns information about the modules available in this vCenter server.
func (c *Manager) ListModules(ctx context.Context) ([]ModuleSummary, error) {
	var res ModuleSummaryList
	url := c.Resource(internal.ModulesPath)
	return res.Summaries, c.Do(ctx, url.Request(http.MethodGet), &res)
}

func memberPath(id string) string {
	return path.Join(internal.ModulesVMPath, id, "members")
}

// ListModuleMembers returns the virtual machines that are members of the module.
func (c *Manager) ListModuleMembers(ctx context.Context, id string) ([]types.ManagedObjectReference, error) {
	var m internal.ModuleMembers
	url := c.Resource(memberPath(id))
	err := c.Do(ctx, url.Request(http.MethodGet), &m)
	if err != nil {
		return nil, err
	}
	return m.AsReferences(), err
}

func (c *Manager) moduleMembers(ctx context.Context, action string, id string, vms ...mo.Reference) (bool, error) {
	url := c.Resource(memberPath(id)).WithParam("action", action)
	var m internal.ModuleMembers
	for i := range vms {
		m.VMs = append(m.VMs, vms[i].Reference().Value)
	}
	var res internal.Status
	return res.Success, c.Do(ctx, url.Request(http.MethodPost, m), &res)
}

// AddModuleMembers adds virtual machines to the module. These virtual machines are required to be in the same vCenter cluster.
// Returns true if all vms are added, false if a vm is already a member of the module or not within the module's cluster.
func (c *Manager) AddModuleMembers(ctx context.Context, id string, vms ...mo.Reference) (bool, error) {
	return c.moduleMembers(ctx, "add", id, vms...)
}

// RemoveModuleMembers removes virtual machines from the module.
// Returns true if all vms are removed, false if a vm is not a member of the module.
func (c *Manager) RemoveModuleMembers(ctx context.Context, id string, vms ...mo.Reference) (bool, error) {
	return c.moduleMembers(ctx, "remove", id, vms...)
}