Skip to content

Commit

Permalink
EDU-3019: Clarifies confusion between pem and crt in Cloud Worker
Browse files Browse the repository at this point in the history
- Go, Java, Python, Typescript
  • Loading branch information
fairlydurable committed Oct 17, 2024
1 parent e4b74a0 commit 0da4d56
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 29 deletions.
22 changes: 14 additions & 8 deletions docs/getting_started/go/run_workers_with_cloud_go/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,16 @@ They are required for configuring mutual Transport Layer Security (mTLS) protoco
You have a few options to generate certificates.

- Use existing certificate management infrastructure to generate certificates for your Namespace.
- Use Temporal's built-in certificate generation tool [tcld](https://docs.temporal.io/cloud/tcld).
- Use open-source tools like [certstrap](https://github.com/square/certstrap).
- Use Temporal's built-in certificate generation tool [`tcld`](https://docs.temporal.io/cloud/tcld) to create a `.pem` file containing the certificate.
- Use open-source tools like [Certstrap](https://github.com/square/certstrap) to generate a `crt` certificate file or `pem` cryptographic file to store your certificate in portable form.

The next step uses [certstrap](https://github.com/square/certstrap) to generate certificates.
:::info

- A `.crt` certificate file may be encoded in either PEM (Base64) or DER (binary) format.
- A `.pem` file is a Base64 encoded format for certificates, private keys, and other cryptographic data.
It is structured with clear header and footer lines.

:::

**Create a Certificate Authority (CA)**

Expand Down Expand Up @@ -206,7 +212,7 @@ Next, you will set the required environment variables.

Before running your application, set the following environment variables with the appropriate values provided by your managed Temporal Cloud environment:

- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` or `.crt` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_KEY`: The path to the file with your mTLS private key.
- `TEMPORAL_HOST_URL`: The host URL of your managed Temporal Cloud environment.
- `TEMPORAL_NAMESPACE`: The Namespace Name and Account Id associated with your Temporal Cloud environment.
Expand All @@ -215,8 +221,8 @@ Before running your application, set the following environment variables with th
<TabItem value="macos" label="MacOS">

```bash
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert.pem
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key.pem
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert-file.(pem|crt)
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key-file.(pem|crt)
export TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
export TEMPORAL_NAMESPACE=namespace.account-id
```
Expand All @@ -225,8 +231,8 @@ export TEMPORAL_NAMESPACE=namespace.account-id
<TabItem value="windows" label="Windows">

```bash
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert.pem
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key.pem
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert-file.(pem|crt)
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key-file.(pem|crt)
set TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
set TEMPORAL_NAMESPACE=namespace.account-id
```
Expand Down
20 changes: 13 additions & 7 deletions docs/getting_started/java/run_workers_with_cloud_java/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ You have a few options to generate certificates.

- Use existing certificate management infrastructure to generate certificates for your Namespace.
- Use Temporal's built-in certificate generation tool [tcld](https://docs.temporal.io/cloud/tcld).
- Use open-source tools like [certstrap](https://github.com/square/certstrap).
- Use open-source tools like [Certstrap](https://github.com/square/certstrap) to generate a `crt` certificate file or `pem` cryptographic file to store your certificate in portable form.

The next step uses [certstrap](https://github.com/square/certstrap) to generate certificates.
:::info

- A `.crt` certificate file may be encoded in either PEM (Base64) or DER (binary) format.
- A `.pem` file is a Base64 encoded format for certificates, private keys, and other cryptographic data.
It is structured with clear header and footer lines.

:::

**Create a Certificate Authority (CA)**

Expand Down Expand Up @@ -226,7 +232,7 @@ Next, you will set the required environment variables.

Before running your application, set the following environment variables with the appropriate values provided by your managed Temporal Cloud environment:

- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` or `.crt` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_KEY`: The path to the file with your mTLS private key.
- `TEMPORAL_HOST_URL`: The host URL of your managed Temporal Cloud environment.
- `TEMPORAL_NAMESPACE`: The Namespace Name and Account Id associated with your Temporal Cloud environment.
Expand All @@ -235,8 +241,8 @@ Before running your application, set the following environment variables with th
<TabItem value="macos" label="MacOS">

```bash
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert.pem
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key.pem
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert-file.(pem|crt)
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key-file.(pem|crt)
export TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
export TEMPORAL_NAMESPACE=namespace.account-id
```
Expand All @@ -245,8 +251,8 @@ export TEMPORAL_NAMESPACE=namespace.account-id
<TabItem value="windows" label="Windows">

```bash
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert.pem
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key.pem
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert-file.(pem|crt)
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key-file.(pem|crt)
set TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
set TEMPORAL_NAMESPACE=namespace.account-id
```
Expand Down
20 changes: 13 additions & 7 deletions docs/getting_started/python/run_workers_with_cloud_python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ You have a few options to generate certificates.

- Use existing certificate management infrastructure to generate certificates for your Namespace.
- Use Temporal's built-in certificate generation tool [tcld](https://docs.temporal.io/cloud/tcld).
- Use open-source tools like [certstrap](https://github.com/square/certstrap).
- Use open-source tools like [Certstrap](https://github.com/square/certstrap) to generate a `crt` certificate file or `pem` cryptographic file to store your certificate in portable form.

The next step uses [certstrap](https://github.com/square/certstrap) to generate certificates.
:::info

- A `.crt` certificate file may be encoded in either PEM (Base64) or DER (binary) format.
- A `.pem` file is a Base64 encoded format for certificates, private keys, and other cryptographic data.
It is structured with clear header and footer lines.

:::

**Create a Certificate Authority (CA)**

Expand Down Expand Up @@ -192,7 +198,7 @@ Next, you will set the required environment variables.

Before running your application, set the following environment variables with the appropriate values provided by your managed Temporal Cloud environment:

- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` or `.crt` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_KEY`: The path to the file with your mTLS private key.
- `TEMPORAL_HOST_URL`: The host URL of your managed Temporal Cloud environment.
- `TEMPORAL_NAMESPACE`: The Namespace Name and Account Id associated with your Temporal Cloud environment.
Expand All @@ -201,8 +207,8 @@ Before running your application, set the following environment variables with th
<TabItem value="macos" label="MacOS">

```bash
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert.pem
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key.pem
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert-file.(pem|crt)
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key-file.(pem|crt)
export TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
export TEMPORAL_NAMESPACE=namespace.account-id
```
Expand All @@ -211,8 +217,8 @@ export TEMPORAL_NAMESPACE=namespace.account-id
<TabItem value="windows" label="Windows">

```bash
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert.pem
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key.pem
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert-file.(pem|crt)
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key-file.(pem|crt)
set TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
set TEMPORAL_NAMESPACE=namespace.account-id
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ You have a few options to generate certificates.

- Use existing certificate management infrastructure to generate certificates for your Namespace.
- Use Temporal's built-in certificate generation tool [tcld](https://docs.temporal.io/cloud/tcld).
- Use open-source tools like [certstrap](https://github.com/square/certstrap).
- Use open-source tools like [Certstrap](https://github.com/square/certstrap) to generate a `crt` certificate file or `pem` cryptographic file to store your certificate in portable form.

The next step uses [certstrap](https://github.com/square/certstrap) to generate certificates.
:::info

- A `.crt` certificate file may be encoded in either PEM (Base64) or DER (binary) format.
- A `.pem` file is a Base64 encoded format for certificates, private keys, and other cryptographic data.
It is structured with clear header and footer lines.

:::

**Create a Certificate Authority (CA)**

Expand Down Expand Up @@ -197,7 +203,7 @@ Next, you will set the required environment variables.

Before running your application, set the following environment variables with the appropriate values provided by your managed Temporal Cloud environment:

- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_CERT`: The path to the `.pem` or `.crt` file with your mTLS x509 Certificate.
- `TEMPORAL_MTLS_TLS_KEY`: The path to the file with your mTLS private key.
- `TEMPORAL_HOST_URL`: The host URL of your managed Temporal Cloud environment.
- `TEMPORAL_NAMESPACE`: The Namespace Name and Account Id associated with your Temporal Cloud environment.
Expand All @@ -206,8 +212,8 @@ Before running your application, set the following environment variables with th
<TabItem value="macos" label="MacOS">

```bash
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert.pem
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key.pem
export TEMPORAL_MTLS_TLS_CERT=/path/to/tls/cert-file.(pem|crt)
export TEMPORAL_MTLS_TLS_KEY=/path/to/tls/key-file.(pem|crt)
export TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
export TEMPORAL_NAMESPACE=namespace.account-id
```
Expand All @@ -216,8 +222,8 @@ export TEMPORAL_NAMESPACE=namespace.account-id
<TabItem value="windows" label="Windows">

```bash
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert.pem
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key.pem
set TEMPORAL_MTLS_TLS_CERT=C:\path\to\tls\cert-file.(pem|crt)
set TEMPORAL_MTLS_TLS_KEY=C:\path\to\tls\key-file.(pem|crt)
set TEMPORAL_HOST_URL=https://namespace.account-id.tmprl.cloud:port
set TEMPORAL_NAMESPACE=namespace.account-id
```
Expand Down

0 comments on commit 0da4d56

Please sign in to comment.