contract-go

README

Contract Go

Introduction

The library has been developed to automate the process of provisioning Hyper Protect Virtual Servers (HPVS) and Hyper Protect Container Runtime for RedHat Virtualization solutions (HPCR RHVS).

For more details on Hyper Protect Virtual Servers for VPC and Hyper Protect Container Runtime, refer Confidential computing with LinuxONE and IBM Hyper Protect Virtual Servers.

Features

1. Decrypt encrypted attestation records.
2. Download encryption certificates from IBM Cloud docs.
3. Get specific encryption certificate from encryption certificates JSON downloaded.
4. Generate Base64 of a string.
5. Validate schema of unencrypted contract.
6. Generate IBM Hyper Protect encrypted string.
7. Generate IBM Hyper Protect signed and encrypted contract (With and without contract expiry).
8. Generate Base64 tar of docker-compose.yaml or pods.yaml.
9. Get latest HPCR Image from IBM Cloud Image JSON data.
10. Validate schema of network-config (for on-prem environment) for HPVS and HPCR RHVS.

Usage

Refer Docs for more details on how to leverage this library for your usecases.

References

• contract-cli - CLI tool for generating Hyper Protect contracts (leverages contract-go)
• terraform-provider-hpcr - Terraform Provider for generating Hyper Protect contracts
• k8s-operator-hpcr - Kubernetes operator for generating Hyper Protect contracts
• linuxone-vsi-automation-samples - hpvs - Terraform examples to provision HPVS
• linuxone-vsi-automation-samples - hpcr-rhvs - Terraform examples to provision HPCR RHVS
• hyper-protect-virtual-server-samples - HPVS scripts for different features

Contributors