-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathenrollment.go
More file actions
235 lines (208 loc) · 8.21 KB
/
Copy pathenrollment.go
File metadata and controls
235 lines (208 loc) · 8.21 KB
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
// SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
// 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 enrollment provides shared enrollment functionality for the Fleet Intelligence agent.
package enrollment
import (
"context"
"fmt"
"net/url"
"strings"
"time"
"github.com/NVIDIA/fleet-intelligence-sdk/pkg/log"
pkgmetadata "github.com/NVIDIA/fleet-intelligence-sdk/pkg/metadata"
nvidianvml "github.com/NVIDIA/fleet-intelligence-sdk/pkg/nvidia-query/nvml"
"github.com/NVIDIA/fleet-intelligence-sdk/pkg/sqlite"
"github.com/NVIDIA/fleet-intelligence-agent/internal/agentstate"
"github.com/NVIDIA/fleet-intelligence-agent/internal/backendclient"
"github.com/NVIDIA/fleet-intelligence-agent/internal/config"
"github.com/NVIDIA/fleet-intelligence-agent/internal/endpoint"
"github.com/NVIDIA/fleet-intelligence-agent/internal/inventory"
inventorysink "github.com/NVIDIA/fleet-intelligence-agent/internal/inventory/sink"
inventorysource "github.com/NVIDIA/fleet-intelligence-agent/internal/inventory/source"
"github.com/NVIDIA/fleet-intelligence-agent/internal/machineinfo"
"github.com/NVIDIA/fleet-intelligence-agent/internal/registry"
)
var (
newBackendClient = backendclient.New
syncInventoryAfterEnroll = syncInventoryOnce
postEnrollInventorySyncTimeout = time.Minute
)
// EnrollMetadata contains optional enrollment metadata values persisted for runtime use.
type EnrollMetadata struct {
NodeGroup *string
ComputeZone *string
}
// Enroll runs the full enrollment workflow and performs a best-effort initial inventory sync.
func Enroll(ctx context.Context, baseEndpoint, sakToken string) error {
return EnrollWithConfig(ctx, baseEndpoint, sakToken, nil)
}
// EnrollWithConfig runs the full enrollment workflow and uses cfg for best-effort inventory metadata.
func EnrollWithConfig(ctx context.Context, baseEndpoint, sakToken string, cfg *config.Config) error {
return EnrollWithConfigAndMetadata(ctx, baseEndpoint, sakToken, cfg, nil)
}
// EnrollWithConfigAndMetadata runs the full enrollment workflow and persists optional metadata values.
func EnrollWithConfigAndMetadata(ctx context.Context, baseEndpoint, sakToken string, cfg *config.Config, metadata *EnrollMetadata) error {
baseURL, err := normalizeBackendBaseURL(baseEndpoint)
if err != nil {
return fmt.Errorf("invalid enrollment endpoint: %w", err)
}
client, err := newBackendClient(baseURL.String())
if err != nil {
return fmt.Errorf("failed to create backend client: %w", err)
}
jwtToken, err := client.Enroll(ctx, sakToken)
if err != nil {
return err
}
enrolledAt := time.Now().UTC()
if err := storeConfigInMetadata(ctx, baseURL.String(), jwtToken, sakToken, enrolledAt, normalizedEnrollMetadata(metadata)); err != nil {
return fmt.Errorf("failed to store configuration: %w", err)
}
syncCtx, cancel := context.WithTimeout(ctx, postEnrollInventorySyncTimeout)
defer cancel()
if err := runWithContext(syncCtx, func() error {
return syncInventoryAfterEnroll(syncCtx, cfg)
}); err != nil {
log.Logger.Warnw("post-enroll inventory sync failed", "error", err)
}
return nil
}
func runWithContext(ctx context.Context, fn func() error) error {
if err := ctx.Err(); err != nil {
return err
}
done := make(chan error, 1)
go func() {
done <- fn()
}()
select {
case err := <-done:
return err
case <-ctx.Done():
return ctx.Err()
}
}
func normalizeBackendBaseURL(raw string) (*url.URL, error) {
baseURL, err := endpoint.ValidateBackendEndpoint(raw)
if err != nil {
return nil, err
}
if baseURL.Path == "" || baseURL.Path == "/" {
return baseURL, nil
}
normalized, err := endpoint.DeriveBackendBaseURL(raw)
if err != nil {
return nil, err
}
return endpoint.ValidateBackendEndpoint(normalized)
}
func normalizedEnrollMetadata(metadata *EnrollMetadata) EnrollMetadata {
if metadata == nil {
return EnrollMetadata{}
}
return EnrollMetadata{
NodeGroup: trimmedOptionalString(metadata.NodeGroup),
ComputeZone: trimmedOptionalString(metadata.ComputeZone),
}
}
func trimmedOptionalString(value *string) *string {
if value == nil {
return nil
}
trimmed := strings.TrimSpace(*value)
return &trimmed
}
func storeConfigInMetadata(ctx context.Context, baseURL, jwtToken, sakToken string, enrolledAt time.Time, metadata EnrollMetadata) error {
stateFile, err := config.DefaultStateFile()
if err != nil {
return fmt.Errorf("failed to get state file path: %w", err)
}
dbRW, err := sqlite.Open(stateFile)
if err != nil {
return fmt.Errorf("failed to open state database: %w", err)
}
defer dbRW.Close()
if err := config.SecureStateFilePermissions(stateFile); err != nil {
return fmt.Errorf("failed to secure state database permissions: %w", err)
}
if err := pkgmetadata.CreateTableMetadata(ctx, dbRW); err != nil {
return fmt.Errorf("failed to create metadata table: %w", err)
}
if err := pkgmetadata.SetMetadata(ctx, dbRW, agentstate.MetadataKeySAKToken, sakToken); err != nil {
return fmt.Errorf("failed to set SAK token: %w", err)
}
if err := pkgmetadata.SetMetadata(ctx, dbRW, pkgmetadata.MetadataKeyToken, jwtToken); err != nil {
return fmt.Errorf("failed to set JWT token: %w", err)
}
if err := pkgmetadata.SetMetadata(ctx, dbRW, agentstate.MetadataKeyBackendBaseURL, baseURL); err != nil {
return fmt.Errorf("failed to set backend base URL: %w", err)
}
if err := pkgmetadata.SetMetadata(ctx, dbRW, agentstate.MetadataKeyEnrolledAt, enrolledAt.Format(time.RFC3339Nano)); err != nil {
return fmt.Errorf("failed to set enrollment time: %w", err)
}
if metadata.NodeGroup != nil {
if err := pkgmetadata.SetMetadata(ctx, dbRW, agentstate.MetadataKeyNodeGroup, *metadata.NodeGroup); err != nil {
return fmt.Errorf("failed to set node_group: %w", err)
}
}
if metadata.ComputeZone != nil {
if err := pkgmetadata.SetMetadata(ctx, dbRW, agentstate.MetadataKeyComputeZone, *metadata.ComputeZone); err != nil {
return fmt.Errorf("failed to set compute zone: %w", err)
}
}
return nil
}
type machineInfoCollectorFunc func(context.Context) (*machineinfo.MachineInfo, error)
func (f machineInfoCollectorFunc) Collect(ctx context.Context) (*machineinfo.MachineInfo, error) {
return f(ctx)
}
func syncInventoryOnce(ctx context.Context, cfg *config.Config) error {
state := agentstate.NewSQLite()
sink := inventorysink.NewBackendSink(state)
allComponents := registry.AllComponentNames()
if cfg == nil {
var err error
cfg, err = config.Default(ctx)
if err != nil {
return fmt.Errorf("load default config for inventory sync: %w", err)
}
}
retentionPeriodSeconds, enabledComponents, disabledComponents := cfg.InventoryAgentConfig(allComponents)
inventoryEnabled, inventoryIntervalSeconds := cfg.InventoryLoopAgentConfig()
attestationEnabled, attestationIntervalSeconds := cfg.AttestationLoopAgentConfig()
nvmlInstance, err := nvidianvml.New()
if err != nil {
return fmt.Errorf("initialize nvml for inventory sync: %w", err)
}
defer func() { _ = nvmlInstance.Shutdown() }()
src := inventorysource.NewMachineInfoSourceWithAgentConfig(
machineInfoCollectorFunc(func(context.Context) (*machineinfo.MachineInfo, error) {
return machineinfo.GetMachineInfo(nvmlInstance)
}),
&inventory.AgentConfig{
TotalComponents: int64(len(allComponents)),
RetentionPeriodSeconds: retentionPeriodSeconds,
EnabledComponents: enabledComponents,
DisabledComponents: disabledComponents,
InventoryEnabled: inventoryEnabled,
InventoryIntervalSeconds: inventoryIntervalSeconds,
AttestationEnabled: attestationEnabled,
AttestationIntervalSeconds: attestationIntervalSeconds,
},
)
manager := inventory.NewManager(src, sink, inventory.InventoryConfig{})
_, err = manager.CollectOnce(ctx)
return err
}