Skip to content

Commit 9f12f7e

Browse files
DuologicDuologic
authored
feat(crossplane): split off core libs into separate repository (jsonnet-libs#486)
1 parent 71f6a5f commit 9f12f7e

File tree

5 files changed

+843
-0
lines changed

5 files changed

+843
-0
lines changed

‎.github/workflows/main.yml

+41
Original file line numberDiff line numberDiff line change
@@ -851,6 +851,46 @@
851851
"SSH_KEY": "${{ secrets.DEPLOY_KEY }}"
852852
"if": "steps.filter.outputs.workflows == 'true'"
853853
"run": "make libs/crossplane"
854+
"crossplane-core":
855+
"name": "Generate crossplane-core Jsonnet library and docs"
856+
"needs":
857+
- "build"
858+
- "repos"
859+
"runs-on": "ubuntu-latest"
860+
"steps":
861+
- "uses": "actions/checkout@v4"
862+
- "id": "filter"
863+
"uses": "dorny/paths-filter@v3"
864+
"with":
865+
"filters": |
866+
workflows:
867+
- '.github/**'
868+
- 'bin/**'
869+
- 'Dockerfile'
870+
- 'go.mod'
871+
- 'go.sum'
872+
- 'jsonnet/**'
873+
- 'main.go'
874+
- 'Makefile'
875+
- 'pkg/**'
876+
- 'scripts/**'
877+
- 'tf/**'
878+
- 'libs/crossplane-core/**'
879+
- "if": "steps.filter.outputs.workflows == 'true'"
880+
"uses": "actions/download-artifact@v4"
881+
"with":
882+
"name": "docker-artifact"
883+
"path": "artifacts"
884+
- "if": "steps.filter.outputs.workflows == 'true'"
885+
"run": "make load"
886+
- "env":
887+
"DIFF": "true"
888+
"GEN_COMMIT": "${{ github.ref == 'refs/heads/master' && github.repository == 'jsonnet-libs/k8s' }}"
889+
"GIT_COMMITTER_EMAIL": "[email protected]"
890+
"GIT_COMMITTER_NAME": "jsonnet-libs-bot"
891+
"SSH_KEY": "${{ secrets.DEPLOY_KEY }}"
892+
"if": "steps.filter.outputs.workflows == 'true'"
893+
"run": "make libs/crossplane-core"
854894
"datadog-operator":
855895
"name": "Generate datadog-operator Jsonnet library and docs"
856896
"needs":
@@ -2359,6 +2399,7 @@
23592399
- "consul"
23602400
- "contour"
23612401
- "crossplane"
2402+
- "crossplane-core"
23622403
- "datadog-operator"
23632404
- "eck-operator"
23642405
- "edp-keycloak-operator"

‎libs/crossplane-core/config.jsonnet

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
local config = import 'jsonnet/config.jsonnet';
2+
3+
config.new(
4+
name='crossplane-core',
5+
specs=[
6+
// Crossplane itself
7+
// Release support table: https://github.com/crossplane/crossplane#releases
8+
{
9+
output: 'crossplane/1.17',
10+
prefix: '^io\\.crossplane\\.(pkg|apiextensions)\\..*',
11+
crds: ['https://doc.crds.dev/raw/github.com/crossplane/[email protected]'],
12+
localName: 'crossplane',
13+
patchDir: 'custom/crossplane',
14+
},
15+
16+
// Common functions
17+
{
18+
output: 'function-patch-and-transform/0.7',
19+
prefix: '^io\\.crossplane\\.fn\\.pt\\..*',
20+
crds: ['https://raw.githubusercontent.com/crossplane-contrib/function-patch-and-transform/refs/tags/v0.7.0/package/input/pt.fn.crossplane.io_resources.yaml'],
21+
localName: 'function_patch_and_transform',
22+
},
23+
{
24+
output: 'function-cel-filter/0.1',
25+
prefix: '^io\\.crossplane\\.fn\\.cel\\..*',
26+
crds: ['https://raw.githubusercontent.com/crossplane-contrib/function-cel-filter/refs/tags/v0.1.1/package/input/cel.fn.crossplane.io_filters.yaml'],
27+
localName: 'function_cel_filter',
28+
},
29+
]
30+
)

‎libs/crossplane-core/custom/crossplane/compositeResourceDefinition.libsonnet

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
local d = import 'doc-util/main.libsonnet';
2+
3+
{
4+
apiextensions+: {
5+
v1+: {
6+
xrd: self.compositeResourceDefinition,
7+
compositeResourceDefinition+: {
8+
9+
'#new':: d.fn(help=|||
10+
new returns an instance of CompositeResourceDefinition=
11+
12+
For example: xpostgresqlinstances.example.org
13+
14+
- `kind`: XPostgreSQLInstance
15+
- `plural`: xpostgresqlinstances
16+
- `group`: example.org
17+
18+
A common convention is that the XR (composite resource) are prefixed with 'X'
19+
while claim names are not. This lets app team members think of creating a claim
20+
as (e.g.) 'creating a PostgreSQLInstance'. Use `withClaimNames` to set this.
21+
|||, args=[
22+
d.arg('kind', d.T.string),
23+
d.arg('plural', d.T.string),
24+
d.arg('group', d.T.string),
25+
]),
26+
new(kind, plural, group):
27+
super.new(plural + '.' + group)
28+
+ super.metadata.withAnnotations({
29+
// Tell Tanka to not set metadata.namespace.
30+
'tanka.dev/namespaced': 'false',
31+
})
32+
+ super.spec.withGroup(group)
33+
+ super.spec.names.withKind(kind)
34+
+ super.spec.names.withPlural(plural)
35+
,
36+
37+
'#withClaimNames':: d.fn(help=|||
38+
Sets the ClaimNames attribute.
39+
40+
Example:
41+
- `kind`: PostgreSQLInstance
42+
- `plural`: postgresqlinstances
43+
44+
A common convention is that the XR (composite resource) are prefixed with 'X'
45+
while claim names are not. This lets app team members think of creating a claim
46+
as (e.g.) 'creating a PostgreSQLInstance'.
47+
|||, args=[
48+
d.arg('kind', d.T.string),
49+
d.arg('plural', d.T.string),
50+
]),
51+
withClaimNames(kind, plural):
52+
super.spec.claimNames.withKind(kind)
53+
+ super.spec.claimNames.withPlural(plural),
54+
55+
'#mapVersions':: d.fn(help=|||
56+
Sets the ClaimNames attribute.
57+
58+
Example:
59+
- `kind`: PostgreSQLInstance
60+
- `plural`: postgresqlinstances
61+
62+
A common convention is that the XR (composite resource) are prefixed with 'X'
63+
while claim names are not. This lets app team members think of creating a claim
64+
as (e.g.) 'creating a PostgreSQLInstance'.
65+
|||, args=[
66+
d.arg('kind', d.T.string),
67+
d.arg('plural', d.T.string),
68+
]),
69+
mapVersions(f): {
70+
local versions = super.spec.versions,
71+
spec+: {
72+
versions: std.map(f, versions),
73+
},
74+
},
75+
},
76+
},
77+
},
78+
}

‎libs/crossplane-core/custom/crossplane/composition.libsonnet

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
local d = import 'doc-util/main.libsonnet';
2+
3+
{
4+
apiextensions+: {
5+
v1+: {
6+
composition+: {
7+
'#fromXRD':: d.fn(help=|||
8+
Create a Composition based on an XRD.
9+
10+
Attributes:
11+
- `name` of the composition
12+
- `namespace` where connectionDetails are propagated too, commonly the the
13+
management namespace (ie. crossplane)
14+
- `provider` of the resources in this composition
15+
- `xrdRef` XRD object with which this composition is compatible
16+
- `xrdVersion` Version of XRD object with which this composition is compatible
17+
|||, args=[
18+
d.arg('name', d.T.string),
19+
d.arg('namespace', d.T.string),
20+
d.arg('provider', d.T.string),
21+
d.arg('xrdRef', d.T.object),
22+
d.arg('xrdVersion', d.T.string),
23+
]),
24+
fromXRD(name, namespace, provider, xrdRef, xrdVersion):
25+
super.new(name)
26+
+ super.metadata.withAnnotations({
27+
// Tell Tanka to not set metadata.namespace.
28+
'tanka.dev/namespaced': 'false',
29+
})
30+
+ super.metadata.withLabels({
31+
// An optional convention is to include a label of the XRD. This allows easy
32+
// discovery of compatible Compositions.
33+
'crossplane.io/xrd': xrdRef.metadata.name,
34+
// Another optional convention is to include a label of the (most common)
35+
// provider for the resource(s) in this composition. This label can be used in
36+
// 'compositionSelector' in an XR or Claim.
37+
provider: provider,
38+
})
39+
40+
// Each Composition must declare that it is compatible with a particular type of
41+
// Composite Resource using its 'compositeTypeRef' field. The referenced
42+
// version must be marked 'referenceable' in the XRD that defines the XR.
43+
+ super.spec.compositeTypeRef.withApiVersion(xrdRef.spec.group + '/' + xrdVersion)
44+
+ super.spec.compositeTypeRef.withKind(xrdRef.spec.names.kind)
45+
46+
47+
// When an XR is created in response to a claim Crossplane needs to know where it
48+
// should create the XR's connection secret. This is configured using the
49+
// 'writeConnectionSecretsToNamespace' field.
50+
+ super.spec.withWriteConnectionSecretsToNamespace(namespace),
51+
},
52+
},
53+
},
54+
}

0 commit comments

Comments
 (0)