feat: expose externalName parameter

grafana · Sep 24, 2024 · 09d5801 · 09d5801
1 parent 75a2628
commit 09d5801
Show file tree

Hide file tree

Showing 101 changed files with 1,590 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-LIBRARY_VERSION:=0.0.2
+LIBRARY_VERSION:=0.0.3
 PROVIDER_VERSION:=0.18.0
 JSONNET_BIN:=jrsonnet
 

diff --git a/docs/README.md b/docs/README.md
@@ -24,7 +24,7 @@ The library in `main.libsonnet` can be used to build objects for these XRDs.
 ## Install
 
 ```
-jb install github.com/Duologic/grafana-crossplane-libsonnet/[email protected].1-0.18.0
+jb install github.com/Duologic/grafana-crossplane-libsonnet/[email protected].3-0.18.0
 ```
 
 ## Usage

diff --git a/docs/alerting/v1alpha1/contactPoint/index.md b/docs/alerting/v1alpha1/contactPoint/index.md
@@ -99,6 +99,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -799,6 +800,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/alerting/v1alpha1/messageTemplate.md b/docs/alerting/v1alpha1/messageTemplate.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -672,6 +673,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/alerting/v1alpha1/muteTiming/index.md b/docs/alerting/v1alpha1/muteTiming/index.md
@@ -59,6 +59,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -679,6 +680,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/alerting/v1alpha1/notificationPolicy/index.md b/docs/alerting/v1alpha1/notificationPolicy/index.md
@@ -59,6 +59,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -729,6 +730,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/alerting/v1alpha1/ruleGroup/index.md b/docs/alerting/v1alpha1/ruleGroup/index.md
@@ -59,6 +59,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -723,6 +724,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/accessPolicy/index.md b/docs/cloud/v1alpha1/accessPolicy/index.md
@@ -59,6 +59,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -643,6 +644,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/accessPolicyToken.md b/docs/cloud/v1alpha1/accessPolicyToken.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -674,6 +675,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/pluginInstallation.md b/docs/cloud/v1alpha1/pluginInstallation.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -670,6 +671,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/stack.md b/docs/cloud/v1alpha1/stack.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -642,6 +643,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/stackServiceAccount.md b/docs/cloud/v1alpha1/stackServiceAccount.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -672,6 +673,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet

diff --git a/docs/cloud/v1alpha1/stackServiceAccountToken.md b/docs/cloud/v1alpha1/stackServiceAccountToken.md
@@ -54,6 +54,7 @@
     * [`fn withMatchLabelsMixin(value)`](#fn-speccompositionselectorwithmatchlabelsmixin)
   * [`obj parameters`](#obj-specparameters)
     * [`fn withDeletionPolicy(value="Delete")`](#fn-specparameterswithdeletionpolicy)
+    * [`fn withExternalName(value)`](#fn-specparameterswithexternalname)
     * [`fn withForProvider(value)`](#fn-specparameterswithforprovider)
     * [`fn withForProviderMixin(value)`](#fn-specparameterswithforprovidermixin)
     * [`fn withInitProvider(value)`](#fn-specparameterswithinitprovider)
@@ -712,6 +713,21 @@ This field is planned to be deprecated in favor of the ManagementPolicies
 field in a future release. Currently, both could be set independently and
 non-default values would be honored if the feature flag is enabled.
 See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223
+##### fn spec.parameters.withExternalName
+
+```jsonnet
+spec.parameters.withExternalName(value)
+```
+
+PARAMETERS:
+
+* **value** (`string`)
+
+The name of the managed resource inside the Provider.
+By default Providers give external resources the same name as the Kubernetes object. A provider uses the external name to lookup a managed resource in an external system. The provider looks up the resource in the external system to determine if it exists, and if it matches the managed resource’s desired state. If the provider can’t find the resource, it creates it.
+
+Docs: https://docs.crossplane.io/latest/concepts/managed-resources/#naming-external-resources
+
 ##### fn spec.parameters.withForProvider
 
 ```jsonnet