adding configuration to Plan

Author: patrykorwat

artifacts/plans/s3-plan.yaml

@@ -0,0 +1,9 @@
+apiVersion: hykube.io/v1alpha1
+kind: Plan
+metadata:
+  name: aws-test
+spec:
+  provider:
+    name: aws
+    config:
+      test: "true"

docs/local-development.md

@@ -76,6 +76,8 @@ kubectl create -f artifacts/deployment/apiservice.yaml
 
 ## Test that your setup has worked
 
+### Testing provider
+
 You should now be able to create the resource type `Provider` which is the resource type registered by the API server.
 
 ```shell
@@ -103,8 +105,16 @@ kubectl get provider aws -o custom-columns=Name:.metadata.name,status:.status,Cr
 Once the provider is ready, you can add a test AWS S3 bucket:
 
 ```shell
-kubectl create -f artifacts/aws-test/s3-bucket.yaml                                                                       
-kubectl delete -f artifacts/aws-test/s3-bucket.yaml                                                                       
+kubectl create -f artifacts/aws-test/s3-bucket.yaml
+# aws-s3-bucket.aws.hykube.io/test-bucket created
+```
+
+## Testing plan
+
+One a provider is installed and test resource is added, we invoke a plan to perform synchronization:
+
+```shell
+kubectl create -f artifacts/plans/s3-plan.yaml
 # aws-s3-bucket.aws.hykube.io/test-bucket created
 ```
 

hack/hykube_apiserver_violation_exceptions.list

@@ -1,3 +1,6 @@
+API rule violation: names_match,github.com/infrapot/hykube/pkg/apis/hykube/v1alpha1,PlanSpec,Provider
+API rule violation: names_match,github.com/infrapot/hykube/pkg/apis/hykube/v1alpha1,ProviderPlanDetails,Config
+API rule violation: names_match,github.com/infrapot/hykube/pkg/apis/hykube/v1alpha1,ProviderPlanDetails,Name
 API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,APIResourceList,APIResources
 API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,Duration,Duration
 API rule violation: names_match,k8s.io/apimachinery/pkg/apis/meta/v1,InternalEvent,Object

pkg/apis/hykube/types.go

@@ -10,7 +10,9 @@ For details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
 
 package hykube
 
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
@@ -51,9 +53,23 @@ type PlanList struct {
 	Items []Plan
 }
 
-// PlanSpec is the specification of a Provider.
+type ProviderPlanDetails struct {
+	Name   string
+	Config interface{}
+}
+
+func (p *ProviderPlanDetails) DeepCopy() *ProviderPlanDetails {
+	ret := ProviderPlanDetails{}
+
+	ret.Name = p.Name
+	ret.Config = p.Config // TODO: we assume configuration is always immutable; maybe marshal and unmarshal is better
+
+	return &ret
+}
+
+// PlanSpec is the specification of a Plan.
 type PlanSpec struct {
-	// TODO provider specific configuration
+	Provider ProviderPlanDetails
 }
 
 // +genclient

pkg/apis/hykube/v1alpha1/types.go

@@ -10,7 +10,10 @@ For details, see the GNU AGPL at: http://www.gnu.org/licenses/agpl-3.0.html
 
 package v1alpha1
 
-import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+import (
+	"github.com/infrapot/hykube/pkg/apis/hykube"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +k8s:prerelease-lifecycle-gen:introduced=1.0
@@ -59,7 +62,22 @@ type PlanList struct {
 	Items []Plan `json:"items" protobuf:"bytes,2,rep,name=items"`
 }
 
+type ProviderPlanDetails struct {
+	Name   string
+	Config interface{}
+}
+
+func (p *ProviderPlanDetails) DeepCopy() *ProviderPlanDetails {
+	ret := ProviderPlanDetails{}
+
+	ret.Name = p.Name
+	ret.Config = p.Config // TODO: we assume configuration is always immutable; maybe marshal and unmarshal is better
+
+	return &ret
+}
+
 type PlanSpec struct {
+	Provider hykube.ProviderPlanDetails
 }
 
 type PlanStatus struct {