forked from argoproj/argo-cd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(appset): Implement Plugin Generator (argoproj#13017)
* add internal http package Signed-off-by: Maxence Laude <[email protected]> * add services plugin Signed-off-by: Maxence Laude <[email protected]> * add generator plugin Signed-off-by: Maxence Laude <[email protected]> * adapted matrix && merge generator Signed-off-by: Maxence Laude <[email protected]> * adapted plugin to webhook Signed-off-by: Maxence Laude <[email protected]> * update applicationset controller and types for plugin Signed-off-by: Maxence Laude <[email protected]> * add proposal for applicationset plugin generator Signed-off-by: Maxence Laude <[email protected]> * execute codegen Signed-off-by: Maxence Laude <[email protected]> * First draft of documentation Signed-off-by: Maxence Laude <[email protected]> * Fix wrong expected error on client_test Signed-off-by: Maxence Laude <[email protected]> * docs(plugin-generator): minor improvements Signed-off-by: Sébastien Crocquesel <[email protected]> * Improvement * changes Signed-off-by: Michael Crenshaw <[email protected]> * fix docs Signed-off-by: Michael Crenshaw <[email protected]> * wrap output Signed-off-by: Michael Crenshaw <[email protected]> * fix test Signed-off-by: Michael Crenshaw <[email protected]> * fix tests Signed-off-by: Michael Crenshaw <[email protected]> * nested parameters Signed-off-by: Michael Crenshaw <[email protected]> * simplify Signed-off-by: Michael Crenshaw <[email protected]> * docs Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Michael Crenshaw <[email protected]> * Add plugin to GetRequeueAfter function (merge && matrix) Signed-off-by: Maxence Laude <[email protected]> * Improvement : renaming * more changes Signed-off-by: Michael Crenshaw <[email protected]> * clearer docs Signed-off-by: Michael Crenshaw <[email protected]> * abstract Signed-off-by: Michael Crenshaw <[email protected]> * naming Signed-off-by: Michael Crenshaw <[email protected]> * revert accidental change Signed-off-by: Michael Crenshaw <[email protected]> * ugh Signed-off-by: Michael Crenshaw <[email protected]> * fix accidental renames Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Michael Crenshaw <[email protected]> * Fix typo renaming Signed-off-by: Maxence Laude <[email protected]> * Improve docs Signed-off-by: Maxence Laude <[email protected]> * Webhook implementation Signed-off-by: Maxence Laude <[email protected]> * Typo docs Signed-off-by: Maxence Laude <[email protected]> * fix plugin generator nil panic Signed-off-by: Michael Crenshaw <[email protected]> * Add company to USERS.md Signed-off-by: Maxence Laude <[email protected]> * input.parameters * fix plugin generator nil panic Signed-off-by: Michael Crenshaw <[email protected]> * input.parameters Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Michael Crenshaw <[email protected]> * Change param structure * change param structure Signed-off-by: Michael Crenshaw <[email protected]> * nest parameters Signed-off-by: Michael Crenshaw <[email protected]> --------- Signed-off-by: Michael Crenshaw <[email protected]> * Fix conflicts Signed-off-by: Maxence Laude <[email protected]> * Fix docs Signed-off-by: Maxence Laude <[email protected]> * Fix docs Signed-off-by: Maxence Laude <[email protected]> --------- Signed-off-by: Maxence Laude <[email protected]> Signed-off-by: Sébastien Crocquesel <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]> Co-authored-by: Sébastien Crocquesel <[email protected]> Co-authored-by: Michael Crenshaw <[email protected]>
- Loading branch information
3 people
authored
Jun 2, 2023
1 parent
8e8970e
commit ec2340a
Showing
34 changed files
with
14,980 additions
and
5,344 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| package generators | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/jeremywohl/flatten" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/client-go/kubernetes" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
||
| argoprojiov1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1" | ||
| "github.com/argoproj/argo-cd/v2/util/settings" | ||
|
|
||
| "github.com/argoproj/argo-cd/v2/applicationset/services/plugin" | ||
| ) | ||
|
|
||
| const ( | ||
| DefaultPluginRequeueAfterSeconds = 30 * time.Minute | ||
| ) | ||
|
|
||
| var _ Generator = (*PluginGenerator)(nil) | ||
|
|
||
| type PluginGenerator struct { | ||
| client client.Client | ||
| ctx context.Context | ||
| clientset kubernetes.Interface | ||
| namespace string | ||
| } | ||
|
|
||
| func NewPluginGenerator(client client.Client, ctx context.Context, clientset kubernetes.Interface, namespace string) Generator { | ||
| g := &PluginGenerator{ | ||
| client: client, | ||
| ctx: ctx, | ||
| clientset: clientset, | ||
| namespace: namespace, | ||
| } | ||
| return g | ||
| } | ||
|
|
||
| func (g *PluginGenerator) GetRequeueAfter(appSetGenerator *argoprojiov1alpha1.ApplicationSetGenerator) time.Duration { | ||
| // Return a requeue default of 30 minutes, if no default is specified. | ||
|
|
||
| if appSetGenerator.Plugin.RequeueAfterSeconds != nil { | ||
| return time.Duration(*appSetGenerator.Plugin.RequeueAfterSeconds) * time.Second | ||
| } | ||
|
|
||
| return DefaultPluginRequeueAfterSeconds | ||
| } | ||
|
|
||
| func (g *PluginGenerator) GetTemplate(appSetGenerator *argoprojiov1alpha1.ApplicationSetGenerator) *argoprojiov1alpha1.ApplicationSetTemplate { | ||
| return &appSetGenerator.Plugin.Template | ||
| } | ||
|
|
||
| func (g *PluginGenerator) GenerateParams(appSetGenerator *argoprojiov1alpha1.ApplicationSetGenerator, applicationSetInfo *argoprojiov1alpha1.ApplicationSet) ([]map[string]interface{}, error) { | ||
|
|
||
| if appSetGenerator == nil { | ||
| return nil, EmptyAppSetGeneratorError | ||
| } | ||
|
|
||
| if appSetGenerator.Plugin == nil { | ||
| return nil, EmptyAppSetGeneratorError | ||
| } | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| providerConfig := appSetGenerator.Plugin | ||
|
|
||
| pluginClient, err := g.getPluginFromGenerator(ctx, applicationSetInfo.Name, providerConfig) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| list, err := pluginClient.List(ctx, providerConfig.Input.Parameters) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error listing params: %w", err) | ||
| } | ||
|
|
||
| res, err := g.generateParams(appSetGenerator, applicationSetInfo, list.Output.Parameters, appSetGenerator.Plugin.Input.Parameters, applicationSetInfo.Spec.GoTemplate) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return res, nil | ||
| } | ||
|
|
||
| func (g *PluginGenerator) getPluginFromGenerator(ctx context.Context, appSetName string, generatorConfig *argoprojiov1alpha1.PluginGenerator) (*plugin.Service, error) { | ||
| cm, err := g.getConfigMap(ctx, generatorConfig.ConfigMapRef.Name) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error fetching ConfigMap: %w", err) | ||
| } | ||
| token, err := g.getToken(ctx, cm["token"]) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error fetching Secret token: %v", err) | ||
| } | ||
|
|
||
| var requestTimeout int | ||
| requestTimeoutStr, ok := cm["requestTimeout"] | ||
| if ok { | ||
| requestTimeout, err = strconv.Atoi(requestTimeoutStr) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error set requestTimeout : %w", err) | ||
| } | ||
| } | ||
|
|
||
| pluginClient, err := plugin.NewPluginService(ctx, appSetName, cm["baseUrl"], token, requestTimeout) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return pluginClient, nil | ||
| } | ||
|
|
||
| func (g *PluginGenerator) generateParams(appSetGenerator *argoprojiov1alpha1.ApplicationSetGenerator, appSet *argoprojiov1alpha1.ApplicationSet, objectsFound []map[string]interface{}, pluginParams argoprojiov1alpha1.PluginParameters, useGoTemplate bool) ([]map[string]interface{}, error) { | ||
| res := []map[string]interface{}{} | ||
|
|
||
| for _, objectFound := range objectsFound { | ||
|
|
||
| params := map[string]interface{}{} | ||
|
|
||
| if useGoTemplate { | ||
| for k, v := range objectFound { | ||
| params[k] = v | ||
| } | ||
| } else { | ||
| flat, err := flatten.Flatten(objectFound, "", flatten.DotStyle) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| for k, v := range flat { | ||
| params[k] = fmt.Sprintf("%v", v) | ||
| } | ||
| } | ||
|
|
||
| params["generator"] = map[string]interface{}{ | ||
| "input": map[string]argoprojiov1alpha1.PluginParameters{ | ||
| "parameters": pluginParams, | ||
| }, | ||
| } | ||
|
|
||
| err := appendTemplatedValues(appSetGenerator.Plugin.Values, params, appSet.Spec.GoTemplate, appSet.Spec.GoTemplateOptions) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| res = append(res, params) | ||
| } | ||
|
|
||
| return res, nil | ||
| } | ||
|
|
||
| func (g *PluginGenerator) getToken(ctx context.Context, tokenRef string) (string, error) { | ||
|
|
||
| if tokenRef == "" || !strings.HasPrefix(tokenRef, "$") { | ||
| return "", fmt.Errorf("token is empty, or does not reference a secret key starting with '$': %v", tokenRef) | ||
| } | ||
|
|
||
| secretName, tokenKey := plugin.ParseSecretKey(tokenRef) | ||
|
|
||
| secret := &corev1.Secret{} | ||
| err := g.client.Get( | ||
| ctx, | ||
| client.ObjectKey{ | ||
| Name: secretName, | ||
| Namespace: g.namespace, | ||
| }, | ||
| secret) | ||
|
|
||
| if err != nil { | ||
| return "", fmt.Errorf("error fetching secret %s/%s: %v", g.namespace, secretName, err) | ||
| } | ||
|
|
||
| secretValues := make(map[string]string, len(secret.Data)) | ||
|
|
||
| for k, v := range secret.Data { | ||
| secretValues[k] = string(v) | ||
| } | ||
|
|
||
| token := settings.ReplaceStringSecret(tokenKey, secretValues) | ||
|
|
||
| return token, err | ||
| } | ||
|
|
||
| func (g *PluginGenerator) getConfigMap(ctx context.Context, configMapRef string) (map[string]string, error) { | ||
| cm := &corev1.ConfigMap{} | ||
| err := g.client.Get( | ||
| ctx, | ||
| client.ObjectKey{ | ||
| Name: configMapRef, | ||
| Namespace: g.namespace, | ||
| }, | ||
| cm) | ||
|
|
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| baseUrl, ok := cm.Data["baseUrl"] | ||
| if !ok || baseUrl == "" { | ||
| return nil, fmt.Errorf("baseUrl not found in ConfigMap") | ||
| } | ||
|
|
||
| token, ok := cm.Data["token"] | ||
| if !ok || token == "" { | ||
| return nil, fmt.Errorf("token not found in ConfigMap") | ||
| } | ||
|
|
||
| return cm.Data, nil | ||
| } |
Oops, something went wrong.