-
Notifications
You must be signed in to change notification settings - Fork 6
/
provider.go
201 lines (167 loc) · 5.14 KB
/
provider.go
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
// SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Gardener contributors
//
// SPDX-License-Identifier: Apache-2.0
package gardener
import (
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"k8s.io/client-go/rest"
"github.com/gardener/diki/pkg/config"
kubeutils "github.com/gardener/diki/pkg/kubernetes/utils"
"github.com/gardener/diki/pkg/provider"
"github.com/gardener/diki/pkg/rule"
"github.com/gardener/diki/pkg/ruleset"
sharedprovider "github.com/gardener/diki/pkg/shared/provider"
)
// Provider is a Gardener Provider that can be used to implement rules
// against a shoot cluster and its controlplane (residing in a seed cluster).
type Provider struct {
id, name string
ShootConfig, SeedConfig *rest.Config
Args Args
rulesets map[string]ruleset.Ruleset
metadata map[string]string
logger *slog.Logger
}
type providerArgs struct {
ShootKubeconfigPath string
SeedKubeconfigPath string
ShootName string
ShootNamespace string
}
// Args are Gardener Provider specific arguments.
type Args struct {
ShootName string
ShootNamespace string
}
var _ provider.Provider = &Provider{}
// New creates a new Provider.
func New(options ...CreateOption) (*Provider, error) {
p := &Provider{
rulesets: make(map[string]ruleset.Ruleset),
}
for _, o := range options {
o(p)
}
var err error
if p.ShootConfig == nil {
err = errors.Join(err, errors.New("shoot config is nil"))
}
if p.SeedConfig == nil {
err = errors.Join(err, errors.New("seed config is nil"))
}
if err2 := validateAgrs(p.Args); err != nil {
err = errors.Join(err, err2)
}
if err != nil {
return nil, err
}
return p, nil
}
func validateAgrs(args Args) error {
var err error
// TODO: improve errors
if len(args.ShootName) == 0 {
err = errors.Join(err, errors.New("field 'shootName' in provider is empty"))
}
// TODO: add test
if len(args.ShootNamespace) == 0 {
err = errors.Join(err, errors.New("field 'shootNamespace' in provider is empty"))
}
return err
}
// RunAll executes all Rulesets registered with the Provider.
func (p *Provider) RunAll(ctx context.Context) (provider.ProviderResult, error) {
return sharedprovider.RunAll(ctx, p, p.rulesets, p.Logger())
}
func rulesetKey(rulesetID, rulesetVersion string) string {
return rulesetID + "--" + rulesetVersion
}
// RunRuleset executes all Rules of a known Ruleset.
func (p *Provider) RunRuleset(ctx context.Context, rulesetID, rulesetVersion string) (ruleset.RulesetResult, error) {
rs, ok := p.rulesets[rulesetKey(rulesetID, rulesetVersion)]
if !ok {
return ruleset.RulesetResult{}, fmt.Errorf("ruleset with id %s and version %s does not exist", rulesetID, rulesetVersion)
}
return rs.Run(ctx)
}
// RunRule executes specific Rule of a known Ruleset.
func (p *Provider) RunRule(ctx context.Context, rulesetID, rulesetVersion, ruleID string) (rule.RuleResult, error) {
rs, ok := p.rulesets[rulesetKey(rulesetID, rulesetVersion)]
if !ok {
return rule.RuleResult{}, fmt.Errorf("ruleset with id %s and version %s does not exist", rulesetID, rulesetVersion)
}
return rs.RunRule(ctx, ruleID)
}
// AddRulesets adds Rulesets to Provider.
func (p *Provider) AddRulesets(rulesets ...ruleset.Ruleset) error {
for _, r := range rulesets {
key := rulesetKey(r.ID(), r.Version())
if _, ok := p.rulesets[key]; ok {
return fmt.Errorf("ruleset with id %s and version %s already exists", r.ID(), r.Version())
}
p.rulesets[key] = r
}
return nil
}
// ID returns the id of the Provider.
func (p *Provider) ID() string {
return p.id
}
// Name returns the name of the Provider.
func (p *Provider) Name() string {
return p.name
}
// Metadata returns the metadata of the Provider.
func (p *Provider) Metadata() map[string]string {
if p.metadata == nil {
p.metadata = map[string]string{}
}
return p.metadata
}
// FromGenericConfig creates a Provider from ProviderConfig.
func FromGenericConfig(providerConf config.ProviderConfig) (*Provider, error) {
providerArgsByte, err := json.Marshal(providerConf.Args)
if err != nil {
return nil, err
}
var providerGardenerArgs providerArgs
if err := json.Unmarshal(providerArgsByte, &providerGardenerArgs); err != nil {
return nil, err
}
shootKubeConfig, err := kubeutils.RESTConfigFromFile(providerGardenerArgs.ShootKubeconfigPath)
if err != nil {
return nil, err
}
seedKubeConfig, err := kubeutils.RESTConfigFromFile(providerGardenerArgs.SeedKubeconfigPath)
if err != nil {
return nil, err
}
args := Args{
ShootName: providerGardenerArgs.ShootName,
ShootNamespace: providerGardenerArgs.ShootNamespace,
}
gardenerProvider, err := New(
WithID(providerConf.ID),
WithName(providerConf.Name),
WithSeedConfig(seedKubeConfig),
WithShootConfig(shootKubeConfig),
WithMetadata(providerConf.Metadata),
WithArgs(args),
)
if err != nil {
return nil, err
}
return gardenerProvider, nil
}
// Logger returns the Provider's logger.
// If not set it set it to slog.Default().With("provider", p.ID()) then return it.
func (p *Provider) Logger() *slog.Logger {
if p.logger == nil {
p.logger = slog.Default().With("provider", p.ID())
}
return p.logger
}