Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Self-Hosted Custom CA Update #3061

Merged
merged 7 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -237,23 +237,42 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
```

19. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM. The custom
certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files:

- **server.crt**
- **server.key**
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM.
Repository, copy the custom SSL certificates in base64 PEM format to the airgap support VM.

maybe? :)


If you do not provide a custom SSL certificate, the airgap setup process will generate a self-signed certificate for
you.

:::warning

The custom SSL certificates must be in base64 PEM format. If you have custom SSL certificates in a different format,
convert them to base64 PEM format before copying them to the support VM. The airgap setup process also expects the
files to be named **server.crt** and **server.key**.
Three items you need to keep in mind when providing custom SSL certificates:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- The custom SSL certificates must be in base64 PEM format. If you have custom SSL certificates in a different
format, convert them to base64 PEM format before copying them to the support VM. The airgap setup process also
expects the files to be named **server.crt** and **server.key**.
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- The custom certificate's Fully Qualified Domain Name (FQDN) must match the hostname or IP address you provide for
the airgap support VM. Otherwise, the airgap setup process will fail due to a certificate mismatch.

- The custom SSL certificates files must have the following permissions bits set:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- **server.crt**: 644
- **server.key**: 600

:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.


The custom certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- **server.crt**
- **server.key**

You also need to update the permissions for the **/data/secret/cert/** directory. This folder is mounted to Harbor
during the airgap setup process and must have access to the custom SSL certificates. Use the following command to
ensure the permissions are set correctly.

```shell
chown -R 10000:10000 /data/secret/cert/*
```

20. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP
address of the airgap support VM. Choose the preferred method for your environment. Be aware that the script will
generate a self-signed certificate for the value you provide.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -238,23 +238,42 @@ If you are working in Vim, press `i` to enter insert mode in the text editor. Pr
```

19. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM. The custom
certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files:

- **server.crt**
- **server.key**
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM.
Repository, copy the custom SSL certificates in base64 PEM format to the airgap support VM.

maybe? :)


If you do not provide a custom SSL certificate, the airgap setup process will generate a self-signed certificate for
you.

:::warning

The custom SSL certificates must be in base64 PEM format. If you have custom SSL certificates in a different format,
convert them to base64 PEM format before copying them to the support VM. The airgap setup process also expects the
files to be named **server.crt** and **server.key**.
Three items you need to keep in mind when providing custom SSL certificates:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- The custom SSL certificates must be in base64 PEM format. If you have custom SSL certificates in a different
format, convert them to base64 PEM format before copying them to the support VM. The airgap setup process also
expects the files to be named **server.crt** and **server.key**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question hehe Which files?

karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- The custom certificate's Fully Qualified Domain Name (FQDN) must match the hostname or IP address you provide for
the airgap support VM. Otherwise, the airgap setup process will fail due to a certificate mismatch.

- The custom SSL certificates files must have the following permissions bits set:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- **server.crt**: 644
- **server.key**: 600

:::
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

The custom certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files:
karl-cardenas-coding marked this conversation as resolved.
Show resolved Hide resolved

- **server.crt**
- **server.key**

You also need to update the permissions for the **/data/secret/cert/** directory. This folder is mounted to Harbor
during the airgap setup process and must have access to the custom SSL certificates. Use the following command to
ensure the permissions are set correctly.

```shell
chown -R 10000:10000 /data/secret/cert/*
```

20. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP
address of the airgap support VM. Choose the preferred method for your environment. Be aware that the script will
generate a self-signed certificate for the value you provide.
Expand Down