Added a cloud-based module, responsible for message notifications, license issuance and validation, information collection, and monitoring functions. #3409

yxxchange · 2023-06-27T02:45:34Z

`🤖 Generated by Copilot at 4882579`

Summary

🐳📜🛠️

This pull request adds the initial code and configuration for the controllers/cloud project, which is a Kubernetes controller that manages CloudClient and License custom resources. The pull request adds the API types, the CRD manifests, the controller logic, the webhook logic, the Dockerfile, the Makefile, the PROJECT file, and the README file for the project. The pull request also adds the .dockerignore and .gitignore files to exclude unnecessary or sensitive files from the docker and git contexts. The pull request uses kubebuilder, controller-gen, kustomize, and docker buildx tools to scaffold and build the project.

Cloud controllers
Scaffolded with kubebuilder
Autumn of codegen

Walkthrough

Add a .dockerignore file to exclude unnecessary or sensitive files from the docker build context (link)
Add a .gitignore file to exclude unwanted or temporary files from the git version control system (link)
Add a Dockerfile to define the steps to build a docker image for the manager binary, using a multi-stage build process and accepting arguments for cross-platform builds (link)
Add a Makefile to define various targets to automate common tasks such as generating code, building binaries, running tests, deploying controllers, and building docker images (link)
Add a PROJECT file to track the information used to scaffold the project and allow the plugins to work properly (link)
Add a README.md file to provide a brief overview of the project and its purpose, as well as instructions on how to get started, contribute, and license the project (link)
Define the API schema for the CloudClient and License custom resources, using structs to represent the spec and status of the resources, and registering the types with the SchemeBuilder (link, link)
Define the group and version information for the cloud API group, using variables and functions to specify the GroupVersion, SchemeBuilder, and AddToScheme (link)
Generate the deepcopy methods for the types defined in the cloud API group, using the controller-gen tool (link)
Add a main function for the manager binary, importing the client auth plugins, the API types, and the controller packages, and setting up the manager with the scheme, the metrics and probe endpoints, the leader election, and the health checks (link)
Generate the CustomResourceDefinition manifests for the CloudClient and License resources, using the controller-gen tool (link, link)
Add a kustomization.yaml file to apply kustomize transformations to the CRD manifests, listing the base resources, the patches, and the configurations (link)
Add a kustomizeconfig.yaml file to configure the kustomize transformations for the CRD manifests, specifying the nameReference, namespace, and varReference fields (link)
Add patches for adding cert-manager annotations to the CloudClient and License CRDs, which tell cert-manager to inject the CA certificate from a specified Certificate resource into the CRDs (link, link)
Add patches for enabling conversion webhooks for the CloudClient and License CRDs, which tell the API server how to invoke the webhooks for converting between different versions of the resources (link, link)
Add a kustomization.yaml file to apply kustomize transformations to the entire project configuration, specifying the namespace, namePrefix, labels, resources, patchesStrategicMerge, and replacements fields (link)

pull-request-size · 2023-06-27T02:45:41Z

Whoa! Easy there, Partner!

This PR is too big. Please break it up into smaller PRs.

sealos-ci-robot · 2023-06-27T02:46:00Z

🤖 Generated by lychee action

Summary

Status	Count
🔍 Total	844
✅ Successful	322
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	521
❓ Unknown	0
🚫 Errors	0

Full action output

Full Github Actions output

codecov · 2023-06-27T02:52:55Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (cf8ba36) 72.97% compared to head (970bcc4) 72.97%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3409   +/-   ##
=======================================
  Coverage   72.97%   72.97%           
=======================================
  Files           8        8           
  Lines         618      618           
=======================================
  Hits          451      451           
  Misses        132      132           
  Partials       35       35

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

fanux · 2023-06-28T06:57:19Z

controllers/cloud/internal/controller/cloudclient_controller.go

+)
+
+// CloudClientReconciler reconciles a CloudClient object
+type CloudClientReconciler struct {


命名头疼。。。。

fanux · 2023-06-28T06:57:58Z

controllers/cloud/internal/controller/cloudclient_controller.go

+// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.14.4/pkg/reconcile
+func (r *CloudClientReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	r.logger.Info("Enter CloudClientReconcile", "namespace:", req.Namespace, "name", req.Name)
+


注意格式

fanux · 2023-06-28T06:59:31Z

controllers/cloud/internal/controller/cloudclient_controller.go

+	}
+
+	r.logger.Info("Try to get the cloud secret resource...")
+	resource := util.NewImportanctResource(&clusterSecret, types.NamespacedName{Namespace: cloud.Namespace, Name: cloud.SecretName})


何为 Importenct Resource?

Some resources related to Licenses contain important information that needs to be stored persistently. If these resources are deleted, it could lead to unforeseen consequences. Therefore, related callback functions are triggered in GetImportanceResource to detect intrusion behavior, and appropriate actions will be taken when such behavior is discovered.

fanux · 2023-06-28T07:03:10Z

controllers/cloud/api/v1/cloudclient_types.go

+// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
+
+// CloudClientSpec defines the desired state of CloudClient
+type CloudClientSpec struct {


CR is a resource not a Client

The purpose of the CloudClient Custom Resource (CR) is to serve as the startup resource for the entire module controller. All reconcile functions need to listen to the CloudClient resource to initiate the interaction process with the cloud. The name CloudClient is indeed quite apt...

fanux · 2023-06-28T07:05:43Z

controllers/cloud/internal/controller/util/util.go

+	FALSE = "false"
+)
+
+func ReadConfigFile(filepath string, logger logr.Logger) (cloud.Config, error) {


Read config form configmap or ENV is better than config file.

…fferent scenarios.

bxy4543 · 2023-07-04T06:33:26Z

controllers/cloud/internal/controller/launcher_controller.go

+	r.logger.Info("Enter LauncherReconcile", "namespace:", req.Namespace, "name", req.Name)
+	if r.Retries > 5 {
+		return ctrl.Result{}, nil
+	}
+	r.Retries++


return ctrl.Result{ Requeue: false}, err

bxy4543 · 2023-07-04T06:49:33Z

controllers/cloud/internal/controller/cloudsync_controller.go

+	config, err = util.ReadConfigFromConfigMap(string(cloud.ConfigName), &configMap)
+	if err != nil {
+		r.logger.Error(err, "failed to read config")
+		return ctrl.Result{}, err


duplicate code: config, err = util.ReadConfigFromConfigMap(string(cloud.ConfigName), &configMap)

bxy4543 · 2023-07-04T07:18:55Z

controllers/cloud/internal/manager/notification_mgr.go

+	}
+}
+
+func NotificationResponseToNotification(resp NotificationResponse) ntf.Notification {


return *ntf.Notification

bxy4543 · 2023-07-04T07:21:50Z

controllers/cloud/internal/manager/notification_mgr.go

+			return err
+		} else {
+			return err
+		}


else { return err }

return err

…cense issuance and validation, information collection, and monitoring functions. (labring#3409) * add a notification controller * fix notification controller bugs, add RWMutex * Add cloudclient reconcile * add license controller and cloudsync controller * add cloudsync controller and fix bugs * fix go mod * fix gitignore bugs * Enhanced the coding standards * add cloud collector controller, fix some bugs * add license monitor * add license monitor * init encrypt account * fix bugs * fix bugs * fix bugs * Simplified the code logic and unified the abstract logic under two different scenarios. * fix bugs * fix bugs * fix bugs * modify the name and fix bugs --------- Co-authored-by: jiahui <bxy4543@gmail.com>

pull-request-size bot added the size/XXL label Jun 27, 2023

sealos-ci-robot added area/api area/cloud area/test labels Jun 27, 2023

yxxchange force-pushed the main branch from 4882579 to de34fe0 Compare June 27, 2023 02:55

sealos-ci-robot added the area/workflow label Jun 27, 2023

yxxchange force-pushed the main branch 8 times, most recently from bc11d6d to 869b069 Compare June 27, 2023 06:03

fanux reviewed Jun 28, 2023

View reviewed changes

yxxchange force-pushed the main branch 8 times, most recently from 3198f3a to b4bae28 Compare June 30, 2023 10:16

yxxchange force-pushed the main branch 2 times, most recently from 4750d14 to 2ef7cab Compare July 1, 2023 15:45

yxxchange and others added 19 commits July 4, 2023 13:09

add a notification controller

5cd3c18

fix notification controller bugs, add RWMutex

5fe764f

Add cloudclient reconcile

4a2abdf

add license controller and cloudsync controller

a4a3bee

add cloudsync controller and fix bugs

4b95ee0

fix go mod

6672819

fix gitignore bugs

b505e60

Enhanced the coding standards

5fac65c

add cloud collector controller, fix some bugs

74f84e4

add license monitor

81c3694

add license monitor

092ee74

init encrypt account

62489b1

fix bugs

0469a54

fix bugs

cd81392

fix bugs

af7ab68

Simplified the code logic and unified the abstract logic under two di…

76f61b3

…fferent scenarios.

fix bugs

f8e8835

fix bugs

7a30bc2

fix bugs

0950989

yxxchange force-pushed the main branch from 2dbd0da to 19ba609 Compare July 4, 2023 05:09

bxy4543 reviewed Jul 4, 2023

View reviewed changes

yxxchange force-pushed the main branch from 19ba609 to 0864d68 Compare July 4, 2023 09:33

modify the name and fix bugs

970bcc4

yxxchange force-pushed the main branch from 0864d68 to 970bcc4 Compare July 4, 2023 09:39

lingdie approved these changes Jul 4, 2023

View reviewed changes

lingdie added this to the v5.0 milestone Jul 4, 2023

lingdie merged commit 2f9eedd into labring:main Jul 4, 2023
62 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added a cloud-based module, responsible for message notifications, license issuance and validation, information collection, and monitoring functions. #3409

Added a cloud-based module, responsible for message notifications, license issuance and validation, information collection, and monitoring functions. #3409

yxxchange commented Jun 27, 2023 •

edited by ghost

Loading

pull-request-size bot commented Jun 27, 2023

sealos-ci-robot commented Jun 27, 2023 •

edited

Loading

codecov bot commented Jun 27, 2023 •

edited

Loading

fanux Jun 28, 2023

fanux Jun 28, 2023

fanux Jun 28, 2023

yxxchange Jun 28, 2023

fanux Jun 28, 2023

yxxchange Jun 28, 2023

fanux Jun 28, 2023

bxy4543 Jul 4, 2023

bxy4543 Jul 4, 2023

bxy4543 Jul 4, 2023

bxy4543 Jul 4, 2023

Added a cloud-based module, responsible for message notifications, license issuance and validation, information collection, and monitoring functions. #3409

Added a cloud-based module, responsible for message notifications, license issuance and validation, information collection, and monitoring functions. #3409

Conversation

yxxchange commented Jun 27, 2023 • edited by ghost Loading

🤖 Generated by Copilot at 4882579

Summary

Walkthrough

pull-request-size bot commented Jun 27, 2023

Whoa! Easy there, Partner!

sealos-ci-robot commented Jun 27, 2023 • edited Loading

🤖 Generated by lychee action

Summary

Full action output

codecov bot commented Jun 27, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yxxchange commented Jun 27, 2023 •

edited by ghost

Loading

`🤖 Generated by Copilot at 4882579`

sealos-ci-robot commented Jun 27, 2023 •

edited

Loading

codecov bot commented Jun 27, 2023 •

edited

Loading