provider-hsdp

module
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2024 License: Apache-2.0

README

Crossplane HSDP Provider

provider-hsdp is a Crossplane provider that is built using Upjet code generation tools and exposes XRM-conformant managed resources for the HSDP API.

Getting Started

Install the provider by using the following command after changing the image tag to the latest release:

kubectl crossplane install provider xpkg.upbound.io/philips-software/provider-hsdp:v0.10.0 provider-hsdp

Alternatively, you can use declarative installation:

cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-hsdp
spec:
  package: xpkg.upbound.io/philips-software/provider-hsdp:v0.10.0
EOF

Credentials

Provider secrets are passed via the ProviderConfig resource which in turn refers to a Kubernetes secret holding HSDP credentials

apiVersion: hsdp.crossplane.io/v1beta1
kind: ProviderConfig
metadata:
  name: default
spec:
  credentials:
    source: Secret
    secretRef:
      name: example-creds
      namespace: crossplane-system
      key: credentials
Secret example
apiVersion: v1
kind: Secret
metadata:
  name: example-creds
  namespace: crossplane-system
type: Opaque
stringData:
  credentials: |
    {
      "service_id": "iam.service.id.here",
      "service_private_key": "----PRIVATE KEY HERE----",
      "region": "us-east",
      "environment": "client-test",
      "debug_log": "/tmp/crossplane.log"
    }
Supported credential keys
credential description Example
service_id Service ID of the IAM Service account to use
service_private_key The RSA private key associated with the IAM Service account
region The HSDP Region to use us-east or eu-west
environment The HSDP Environment to use client-test or prod
debug_log Optional path where debug API traffic is logged in the provider Pod

API Reference

You can see the API reference here

Known limitations

  • Fields which are marked with ForceNew in the Terraform provider do not trigger recreation of resources via Crossplane currently. This is a known issue and will be addressed once CRD Validation rules suport becomes widely available starting in Kubernetes 1.25+

Developing the provider

Refer to the DEVELOPMENT page for details.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Directories

Path Synopsis
Package apis contains Kubernetes API for the provider.
Package apis contains Kubernetes API for the provider.
cdr/v1alpha1
+kubebuilder:object:generate=true +groupName=cdr.hsdp.crossplane.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=cdr.hsdp.crossplane.io +versionName=v1alpha1
dicom/v1alpha1
+kubebuilder:object:generate=true +groupName=dicom.hsdp.crossplane.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=dicom.hsdp.crossplane.io +versionName=v1alpha1
iam/v1alpha1
+kubebuilder:object:generate=true +groupName=iam.hsdp.crossplane.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=iam.hsdp.crossplane.io +versionName=v1alpha1
v1alpha1
Package v1alpha1 contains the core resources of the hsdp jet provider.
Package v1alpha1 contains the core resources of the hsdp jet provider.
v1beta1
Package v1beta1 contains the core resources of the hsdp upjet provider.
Package v1beta1 contains the core resources of the hsdp upjet provider.
cmd
generator command
provider command
cdr
iam
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL