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
|
//
// Copyright 2022, Timo Furrer <tuxtimo@gmail.com>
//
// 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 gitlab
import (
"fmt"
"net/http"
"time"
)
// ClusterAgentsService handles communication with the cluster agents related
// methods of the GitLab API.
//
// GitLab API docs: https://docs.gitlab.com/ee/api/cluster_agents.html
type ClusterAgentsService struct {
client *Client
}
// Agent represents a GitLab agent for Kubernetes.
//
// GitLab API docs: https://docs.gitlab.com/ee/api/cluster_agents.html
type Agent struct {
ID int `json:"id"`
Name string `json:"name"`
CreatedAt *time.Time `json:"created_at"`
CreatedByUserID int `json:"created_by_user_id"`
ConfigProject ConfigProject `json:"config_project"`
}
type ConfigProject struct {
ID int `json:"id"`
Description string `json:"description"`
Name string `json:"name"`
NameWithNamespace string `json:"name_with_namespace"`
Path string `json:"path"`
PathWithNamespace string `json:"path_with_namespace"`
CreatedAt *time.Time `json:"created_at"`
}
func (a Agent) String() string {
return Stringify(a)
}
// AgentToken represents a GitLab agent token.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-tokens-for-an-agent
type AgentToken struct {
ID int `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
AgentID int `json:"agent_id"`
Status string `json:"status"`
CreatedAt *time.Time `json:"created_at"`
CreatedByUserID int `json:"created_by_user_id"`
LastUsedAt *time.Time `json:"last_used_at"`
Token string `json:"token"`
}
func (a AgentToken) String() string {
return Stringify(a)
}
// ListAgentsOptions represents the available ListAgents() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-the-agents-for-a-project
type ListAgentsOptions ListOptions
// ListAgents returns a list of agents registered for the project.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-the-agents-for-a-project
func (s *ClusterAgentsService) ListAgents(pid interface{}, opt *ListAgentsOptions, options ...RequestOptionFunc) ([]*Agent, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents", PathEscape(project))
req, err := s.client.NewRequest(http.MethodGet, uri, opt, options)
if err != nil {
return nil, nil, err
}
var as []*Agent
resp, err := s.client.Do(req, &as)
if err != nil {
return nil, resp, err
}
return as, resp, nil
}
// GetAgent gets a single agent details.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#get-details-about-an-agent
func (s *ClusterAgentsService) GetAgent(pid interface{}, id int, options ...RequestOptionFunc) (*Agent, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d", PathEscape(project), id)
req, err := s.client.NewRequest(http.MethodGet, uri, nil, options)
if err != nil {
return nil, nil, err
}
a := new(Agent)
resp, err := s.client.Do(req, a)
if err != nil {
return nil, resp, err
}
return a, resp, nil
}
// RegisterAgentOptions represents the available RegisterAgent()
// options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#register-an-agent-with-a-project
type RegisterAgentOptions struct {
Name *string `url:"name,omitempty" json:"name,omitempty"`
}
// RegisterAgent registers an agent to the project.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#register-an-agent-with-a-project
func (s *ClusterAgentsService) RegisterAgent(pid interface{}, opt *RegisterAgentOptions, options ...RequestOptionFunc) (*Agent, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents", PathEscape(project))
req, err := s.client.NewRequest(http.MethodPost, uri, opt, options)
if err != nil {
return nil, nil, err
}
a := new(Agent)
resp, err := s.client.Do(req, a)
if err != nil {
return nil, resp, err
}
return a, resp, nil
}
// DeleteAgent deletes an existing agent registration.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#delete-a-registered-agent
func (s *ClusterAgentsService) DeleteAgent(pid interface{}, id int, options ...RequestOptionFunc) (*Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d", PathEscape(project), id)
req, err := s.client.NewRequest(http.MethodDelete, uri, nil, options)
if err != nil {
return nil, err
}
return s.client.Do(req, nil)
}
// ListAgentTokensOptions represents the available ListAgentTokens() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-tokens-for-an-agent
type ListAgentTokensOptions ListOptions
// ListAgentTokens returns a list of tokens for an agent.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#list-tokens-for-an-agent
func (s *ClusterAgentsService) ListAgentTokens(pid interface{}, aid int, opt *ListAgentTokensOptions, options ...RequestOptionFunc) ([]*AgentToken, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d/tokens", PathEscape(project), aid)
req, err := s.client.NewRequest(http.MethodGet, uri, opt, options)
if err != nil {
return nil, nil, err
}
var ats []*AgentToken
resp, err := s.client.Do(req, &ats)
if err != nil {
return nil, resp, err
}
return ats, resp, nil
}
// GetAgentToken gets a single agent token.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#get-a-single-agent-token
func (s *ClusterAgentsService) GetAgentToken(pid interface{}, aid int, id int, options ...RequestOptionFunc) (*AgentToken, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d/tokens/%d", PathEscape(project), aid, id)
req, err := s.client.NewRequest(http.MethodGet, uri, nil, options)
if err != nil {
return nil, nil, err
}
at := new(AgentToken)
resp, err := s.client.Do(req, at)
if err != nil {
return nil, resp, err
}
return at, resp, nil
}
// CreateAgentTokenOptions represents the available CreateAgentToken() options.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#create-an-agent-token
type CreateAgentTokenOptions struct {
Name *string `url:"name,omitempty" json:"name,omitempty"`
Description *string `url:"description,omitempty" json:"description,omitempty"`
}
// CreateAgentToken creates a new token for an agent.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#create-an-agent-token
func (s *ClusterAgentsService) CreateAgentToken(pid interface{}, aid int, opt *CreateAgentTokenOptions, options ...RequestOptionFunc) (*AgentToken, *Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d/tokens", PathEscape(project), aid)
req, err := s.client.NewRequest(http.MethodPost, uri, opt, options)
if err != nil {
return nil, nil, err
}
at := new(AgentToken)
resp, err := s.client.Do(req, at)
if err != nil {
return nil, resp, err
}
return at, resp, nil
}
// RevokeAgentToken revokes an agent token.
//
// GitLab API docs:
// https://docs.gitlab.com/ee/api/cluster_agents.html#revoke-an-agent-token
func (s *ClusterAgentsService) RevokeAgentToken(pid interface{}, aid int, id int, options ...RequestOptionFunc) (*Response, error) {
project, err := parseID(pid)
if err != nil {
return nil, err
}
uri := fmt.Sprintf("projects/%s/cluster_agents/%d/tokens/%d", PathEscape(project), aid, id)
req, err := s.client.NewRequest(http.MethodDelete, uri, nil, options)
if err != nil {
return nil, err
}
return s.client.Do(req, nil)
}
|
