docs(SGR): add hint to ignoreIngress and ignoreEgress usage to securi…

…tyGroupId as well Signed-off-by: Bastien Grasnick <bastien.grasnick@deutschebahn.com>
crossplane-contrib · Oct 6, 2022 · 1632dca · 1632dca
1 parent 469979e
commit 1632dca
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/apis/ec2/manualv1alpha1/securitygrouprule_types.go b/apis/ec2/manualv1alpha1/securitygrouprule_types.go
@@ -58,6 +58,9 @@ type SecurityGroupRuleParameters struct {
 	// +kubebuilder:validation:Required
 	Region *string `json:"region"`
 
+	// If using a SecurityGroup managed by crossplane as reference,
+	// enable ignoreIngress or ignoreEgress on the sg to prevent the
+	// rules to be constantly created and deleted
 	// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-aws/apis/ec2/v1beta1.SecurityGroup
 	// +kubebuilder:validation:Optional
 	// +immutable

diff --git a/package/crds/ec2.aws.crossplane.io_securitygrouprules.yaml b/package/crds/ec2.aws.crossplane.io_securitygrouprules.yaml
@@ -84,6 +84,9 @@ spec:
                       be created in.
                     type: string
                   securityGroupId:
+                    description: If using a SecurityGroup managed by crossplane as
+                      reference, enable ignoreIngress or ignoreEgress on the sg to
+                      prevent the rules to be constantly created and deleted
                     type: string
                   securityGroupIdRef:
                     description: If using a SecurityGroup managed by crossplane as