Skip to content
This repository was archived by the owner on Jun 5, 2025. It is now read-only.

Commit d86267d

Browse files
Merge pull request #121 from Venafi/update-doc-for-emea
Feat: Update doc for emea
2 parents 41bde09 + ce4993e commit d86267d

1 file changed

Lines changed: 33 additions & 14 deletions

File tree

README.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Venafi](https://raw.githubusercontent.com/Venafi/.github/master/images/Venafi_logo.png)](https://www.venafi.com/)
22
[![Apache 2.0 License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
33
![Community Supported](https://img.shields.io/badge/Support%20Level-Community-brightgreen)
4-
![Compatible with TPP 17.3+ & Cloud](https://img.shields.io/badge/Compatibility-TPP%2017.3+%20%26%20Cloud-f9a90c)
4+
![Compatible with TPP 17.3+ & VaaS](https://img.shields.io/badge/Compatibility-TPP%2017.3+%20%26%20VaaS-f9a90c)
55
_**This open source project is community-supported.** To report a problem or share an idea, use
66
**[Issues](../../issues)**; and if you have a suggestion for fixing the issue, please include those details, too.
77
In addition, use **[Pull Requests](../../pulls)** to contribute actual bug fixes or proposed enhancements.
@@ -12,12 +12,12 @@ We welcome and appreciate all contributions. Got questions or want to discuss so
1212

1313
VCert is a Java library, SDK, designed to simplify key generation and enrollment of machine identities
1414
(also known as SSL/TLS certificates and keys) that comply with enterprise security policy by using the
15-
[Venafi Platform](https://www.venafi.com/platform/trust-protection-platform) or
16-
[Venafi Cloud](https://pki.venafi.com/venafi-cloud/).
15+
[Venafi Trust Protection Platform](https://www.venafi.com/platform/trust-protection-platform) or
16+
[Venafi as a Service](https://www.venafi.com/venaficloud).
1717

1818
#### Compatibility
1919

20-
VCert releases are tested using the latest version of Trust Protection Platform and Venafi Cloud.
20+
VCert releases are tested using the latest version of Trust Protection Platform and Venafi as a Service.
2121
The [latest VCert release](../../releases/latest) should be compatible with Trust Protection
2222
Platform 17.3 or higher based on the subset of API methods it consumes. Token Authentication
2323
requires 19.2 or higher; for earlier versions, username/password authentication (deprecated) applies.
@@ -65,7 +65,7 @@ final Config config = Config.builder()
6565
final VCertTknClient client = new VCertTknClient(config);
6666
```
6767

68-
Or instantiate a client for Venafi Cloud:
68+
Or instantiate a client for Venafi as a Service:
6969

7070
```java
7171
//Create an Authentication object with the API Key
@@ -83,9 +83,28 @@ final Config config = Config.builder()
8383
final VCertClient client = new VCertClient(config);
8484
```
8585

86+
Or instantiate a client for Venafi as a Service EU:
87+
88+
```java
89+
//Create an Authentication object with the API Key
90+
final Authentication auth = Authentication.builder()
91+
.apiKey("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
92+
.build();
93+
94+
//Create a Config object setting the Authentication object
95+
final Config config = Config.builder()
96+
.connectorType(ConnectorType.CLOUD)
97+
.baseUrl("https://api.venafi.eu")
98+
.credentials(auth)
99+
.build();
100+
101+
//Create the client with the Config object. The client will be authenticated
102+
final VCertClient client = new VCertClient(config);
103+
```
104+
86105
Then use your client to request certificates:
87106
- For Trust Protection Platform, the `zone` format is the DN of a policy with or without the "\VED\Policy\" prefix (e.g. "\VED\Policy\Certificates\VCert" or simply "Certificates\VCert")
88-
- For Venafi Cloud, the `zone` format is the name of an OutagePREDICT Application and the API Alias of an Issuing Template assigned to it delimited by a single backslash character (e.g. "My Application\My CIT")
107+
- For Venafi as a Service, the `zone` format is the name of an OutagePREDICT Application and the API Alias of an Issuing Template assigned to it delimited by a single backslash character (e.g. "My Application\My CIT")
89108

90109
```java
91110
//////////////////////////////////////
@@ -159,7 +178,7 @@ System.out.println(pemCollection.pemCertificateChain());
159178
```
160179

161180
To specify the desired validity when requesting a certificate from Trust Protection Platform
162-
or Venafi Cloud, use `validityHours()`:
181+
or Venafi as a Service, use `validityHours()`:
163182

164183
```java
165184
CertificateRequest certificateRequest = new CertificateRequest().subject(
@@ -285,11 +304,11 @@ practice which also met our design objective to keep the certificate request pro
285304
VCert users. If you require the ability to specify the CA Template with the request you can use the
286305
TPP REST APIs but please be advised this goes against Venafi recommendations.
287306

288-
## Prerequisites for using with Venafi Cloud
307+
## Prerequisites for using with Venafi as a Service
289308

290-
1. The Venafi Cloud REST API is accessible at https://api.venafi.cloud from the system where VCert
309+
1. The Venafi as a Service REST API is accessible at [https://api.venafi.cloud](https://api.venafi.cloud/vaas) or [https://api.venafi.eu](https://api.venafi.eu/vaas) (if you have an EU account) from the system where VCert
291310
will be executed.
292-
2. You have successfully registered for a Venafi Cloud account, have been granted at least the
311+
2. You have successfully registered for a Venafi as a Service account, have been granted at least the
293312
OutagePREDICT "Resource Owner" role, and know your API key.
294313
3. A CA Account and Issuing Template exist and have been configured with:
295314
1. Recommended Settings values for:
@@ -316,10 +335,10 @@ To run the acceptance tests the following environment variables must be set:
316335
| TPPUSER | Only for TPP connector tests |
317336
| TPPPASSWORD | Only for TPP connector tests |
318337
| TPPZONE | Policy folder for TPP |
319-
| CLOUDURL | Only for Venafi Cloud tests running against non-production environments (uncommon) |
320-
| APIKEY | Obtained by logging into Venafi Cloud after registering |
321-
| CLOUDZONE | Zone ID or ProjectName\ZoneName for Venafi Cloud |
322-
| CLOUDZONE2 | Zone ID or ProjectName\ZoneName for Venafi Cloud for testing empty OU, O, L, ST, and C |
338+
| CLOUDURL | Only for Venafi as a Service tests |
339+
| APIKEY | Obtained by logging into Venafi as a Service after registering |
340+
| CLOUDZONE | Zone ID or ProjectName\ZoneName for Venafi as a Service |
341+
| CLOUDZONE2 | Zone ID or ProjectName\ZoneName for Venafi as a Service for testing empty OU, O, L, ST, and C |
323342

324343
Acceptance test are executed with:
325344

0 commit comments

Comments
 (0)