Skip to content

fix(docs): update go docs for howto compositions #1042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tr0njavolta merged 1 commit into from
Dec 12, 2025
Merged

fix(docs): update go docs for howto compositions #1042

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 25 additions & 26 deletions docs/manuals/cli/howtos/compositions/go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Use this guide after you define your API schema and need to write the logic that
:::important
This guide assumes you're familiar with Go. If you'd like to become more
familiar with Go, the [official tutorials][official-tutorials] are a good place
to start.
to start.
:::

## Prerequisites
Expand Down Expand Up @@ -146,8 +146,8 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
}

bucket := &v1beta1.Bucket{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("Bucket"),
APIVersion: ptr.To(v1beta1.BucketAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketKindBucket),
Spec: &v1beta1.BucketSpec{
ForProvider: &v1beta1.BucketSpecForProvider{
Region: params.Region,
Expand Down Expand Up @@ -204,15 +204,14 @@ import (

"dev.upbound.io/models/com/example/platform/v1alpha1"
"dev.upbound.io/models/io/upbound/aws/s3/v1beta1"
"k8s.io/utils/ptr"

"github.com/crossplane/crossplane-runtime/pkg/logging"
"github.com/crossplane/function-sdk-go/errors"
"github.com/crossplane/function-sdk-go/logging"
fnv1 "github.com/crossplane/function-sdk-go/proto/v1"
"github.com/crossplane/function-sdk-go/request"
"github.com/crossplane/function-sdk-go/resource"
"github.com/crossplane/function-sdk-go/resource/composed"
"github.com/crossplane/function-sdk-go/response"
"k8s.io/utils/ptr"
)

// Function is your composition function.
Expand Down Expand Up @@ -246,7 +245,7 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
}

params := xr.Spec.Parameters
if ptr.Deref(params.Region, "") == "" {
if params.Region == nil || *params.Region == "" {
response.Fatal(rsp, errors.Wrap(err, "missing region"))
return rsp, nil
}
Expand Down Expand Up @@ -277,8 +276,8 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
}()

bucket := &v1beta1.Bucket{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("Bucket"),
APIVersion: ptr.To(v1beta1.BucketAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketKindBucket),
Spec: &v1beta1.BucketSpec{
ForProvider: &v1beta1.BucketSpecForProvider{
Region: params.Region,
Expand Down Expand Up @@ -306,8 +305,8 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
}

acl := &v1beta1.BucketACL{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("BucketACL"),
APIVersion: ptr.To(v1beta1.BucketACLApiVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketACLKindBucketACL),
Spec: &v1beta1.BucketACLSpec{
ForProvider: &v1beta1.BucketACLSpecForProvider{
Bucket: &bucketExternalName,
Expand All @@ -319,13 +318,13 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
desiredComposed["acl"] = acl

boc := &v1beta1.BucketOwnershipControls{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("BucketOwnershipControls"),
APIVersion: ptr.To(v1beta1.BucketOwnershipControlsAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketOwnershipControlsKindBucketOwnershipControls),
Spec: &v1beta1.BucketOwnershipControlsSpec{
ForProvider: &v1beta1.BucketOwnershipControlsSpecForProvider{
Bucket: &bucketExternalName,
Region: params.Region,
Rule: &[]v1beta1.BucketOwnershipControlsSpecForProviderRule{{
Rule: &[]v1beta1.BucketOwnershipControlsSpecForProviderRuleItem{{
ObjectOwnership: ptr.To("BucketOwnerPreferred"),
}},
},
Expand All @@ -334,8 +333,8 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
desiredComposed["boc"] = boc

pab := &v1beta1.BucketPublicAccessBlock{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("BucketPublicAccessBlock"),
APIVersion: ptr.To(v1beta1.BucketPublicAccessBlockAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketPublicAccessBlockKindBucketPublicAccessBlock),
Spec: &v1beta1.BucketPublicAccessBlockSpec{
ForProvider: &v1beta1.BucketPublicAccessBlockSpecForProvider{
Bucket: &bucketExternalName,
Expand All @@ -350,14 +349,14 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
desiredComposed["pab"] = pab

sse := &v1beta1.BucketServerSideEncryptionConfiguration{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("BucketServerSideEncryptionConfiguration"),
APIVersion: ptr.To(v1beta1.BucketServerSideEncryptionConfigurationAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketServerSideEncryptionConfigurationKindBucketServerSideEncryptionConfiguration),
Spec: &v1beta1.BucketServerSideEncryptionConfigurationSpec{
ForProvider: &v1beta1.BucketServerSideEncryptionConfigurationSpecForProvider{
Bucket: &bucketExternalName,
Region: params.Region,
Rule: &[]v1beta1.BucketServerSideEncryptionConfigurationSpecForProviderRule{{
ApplyServerSideEncryptionByDefault: &[]v1beta1.BucketServerSideEncryptionConfigurationSpecForProviderRuleApplyServerSideEncryptionByDefault{{
Rule: &[]v1beta1.BucketServerSideEncryptionConfigurationSpecForProviderRuleItem{{
ApplyServerSideEncryptionByDefault: &[]v1beta1.BucketServerSideEncryptionConfigurationSpecForProviderRuleItemApplyServerSideEncryptionByDefaultItem{{
SseAlgorithm: ptr.To("AES256"),
}},
BucketKeyEnabled: ptr.To(true),
Expand All @@ -367,15 +366,15 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1.RunFunctionRequest)
}
desiredComposed["sse"] = sse

if ptr.Deref(params.Versioning, false) {
if params.Versioning != nil && *params.Versioning {
versioning := &v1beta1.BucketVersioning{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("BucketVersioning"),
APIVersion: ptr.To(v1beta1.BucketVersioningAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketVersioningKindBucketVersioning),
Spec: &v1beta1.BucketVersioningSpec{
ForProvider: &v1beta1.BucketVersioningSpecForProvider{
Bucket: &bucketExternalName,
Region: params.Region,
VersioningConfiguration: &[]v1beta1.BucketVersioningSpecForProviderVersioningConfiguration{{
VersioningConfiguration: &[]v1beta1.BucketVersioningSpecForProviderVersioningConfigurationItem{{
Status: ptr.To("Enabled"),
}},
},
Expand Down Expand Up @@ -436,8 +435,8 @@ All fields in Upbound's Go models have pointer types so that you can specify onl

```go
bucket := &v1beta1.Bucket{
APIVersion: ptr.To("s3.aws.upbound.io/v1beta1"),
Kind: ptr.To("Bucket"),
APIVersion: ptr.To(v1beta1.BucketAPIVersions3AwsUpboundIoV1Beta1),
Kind: ptr.To(v1beta1.BucketKindBucket),
Spec: &v1beta1.BucketSpec{
ForProvider: &v1beta1.BucketSpecForProvider{
Region: ptr.To("us-east-1"),
Expand Down
Loading