Skip to content

Commit ede08e2

Browse files
committed
feat: add HPCR RHVS README
1 parent ce13a63 commit ede08e2

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

terraform-hpcr-rhvs/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## IBM Hyper Protect Container Runtime for Red Hat Virtualization Services for On Prem Examples
2+
3+
## Preparation
4+
5+
1. Make sure to have the [OpenSSL](https://www.openssl.org/) binary installed (see [details](#openssl)).
6+
2. Install the [terraform CLI](https://learn.hashicorp.com/tutorials/terraform/install-cli) for your environment.
7+
3. Make sure you have valid API Key for push logs to IBM Cloud Logs.
8+
4. Follow the description for [HPCR](https://cloud.ibm.com/docs/vpc?topic=vpc-about-se#hpcr_setup_logging) to setup a logging instance.
9+
5. Set either environment variables or fill the template file according to the example README.
10+
11+
## Examples
12+
13+
Follow the README in the subdirectory of the examples for further instructions:
14+
15+
- [IBM Cloud Infrastructure Center](hello-world/README.md) - An Example to bring up nginx through ICIC
16+
17+
18+
## OpenSSL
19+
20+
The [terraform provider](https://registry.terraform.io/providers/ibm-hyper-protect/hpcr/) leverages the [OpenSSL](https://www.openssl.org/) binary for all cryptographic operations in favour of the [golang crypto](https://pkg.go.dev/crypto) packages. This is because the golang libraries are not [FIPS](https://en.wikipedia.org/wiki/FIPS_140-2) certified whereas there exist certified OpenSSL binaries a customer can select.
21+
22+
Make sure to have the binaries installed for your platform. **Note:** on some platforms the default binary is actually a [LibreSSL](https://www.libressl.org/) installation, which is **not** compatible.
23+
24+
Verify your installation via running:
25+
26+
```bash
27+
openssl version
28+
```
29+
30+
this should give an output similar to the following:
31+
32+
```text
33+
OpenSSL 1.1.1q 5 Jul 2022
34+
```
35+
36+
In case you cannot change the OpenSSL binary in the path, you may override the version used by the [terraform provider](https://registry.terraform.io/providers/ibm-hyper-protect/hpcr/) by setting the `OPENSSL_BIN` environment variable to the absolute path of the correct binary, e.g.
37+
38+
```cmd
39+
OPENSSL_BIN="C:\Program Files\OpenSSL-Win64\bin\openssl.exe"
40+
```

0 commit comments

Comments
 (0)