Configure an IBM Cloud Code Engine application to use custom domains

[ad_1]

IBM Cloud Code Engine is a completely managed, serverless platform that runs your containerized workloads, together with net apps, microservices, event-driven capabilities or batch jobs. Code Engine even builds container photographs for you out of your supply code.

All these workloads can seamlessly work collectively as a result of they’re all hosted throughout the similar Kubernetes infrastructure. The Code Engine expertise is designed in order that you could possibly give attention to writing code and never fear concerning the infrastructure that’s wanted to host it.

Conditions

Acceptable permissions to make use of the IBM Cloud Code Engine service. See here for how to manage these.
An utility operating on IBM Cloud Code Engine. You possibly can deploy the take a look at utility from here.
Entry to switch DNS of a public area/hostname. When you personal a website or bought one, you’ll more than likely have entry to handle DNS for that area. Within the instance, we’ve used IBM Cloud Internet Services that help CNAME flattening function to allow us to make use of root area.
A TLS/SSL certificates signed by a public certificates authority.

On this instance, the take a look at utility is deployed on IBM Cloud Code Engine. The unique hostname seems to be one thing much like this https://application-27.zx67dfvbl7l.us-south.codeengine.appdomain.cloud/. We’ll expose this utility utilizing two customized domains:

https://instance.org
https://codeengine.instance.org

Step-by-step directions

Refer this document and the under steps to create the TLS certificates for each domains and use them to show this take a look at utility. You should utilize Let’s Encrypt CA for example to request TLS certificates for these customized domains. Nevertheless, you may also use a TLS certificates from any of the general public certificates authorities.

We’ll observe these steps to perform our targets:

Generate CSR for TLS certificates and get it signed from CA.
Add your area to Code Engine utility UI.
Create CNAME report in DNS on your area identify.

1. Generate CSR for TLS certificates and get it signed from CA

To generate a legitimate signed TLS certificates from Let’s Encrypt CA, you should utilize the Certbot consumer to generate the CSR and get it signed from CA. First, it’s essential to set up the Certbot utilizing these instructions.

Use the next command to begin the method for the certificates technology:

certbot certonly --manual --preferred-challenges dns --email contact@instance.org --server https://acme-v02.api.letsencrypt.org/listing --agree-tos --domain codeengine.instance.org

certbot certonly --manual --preferred-challenges dns --email contact@instance.org --server https://acme-v02.api.letsencrypt.org/listing --agree-tos --domain instance.org

Then, it ought to ask you for the area possession verification step:

root@jumpbox:~# certbot certonly --manual --preferred-challenges dns --email contact@instance.org --server https://acme-v02.api.letsencrypt.org/listing --agree-tos --domain codeengine.instance.org
Saving debug log to /var/log/letsencrypt/letsencrypt.log
Requesting a certificates for codeengine.instance.org

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Please deploy a DNS TXT report below the identify:

_acme-challenge.codeengine.instance.org

with the next worth:

Fq2wbN9mUSfnWZkGXyaEgVaOm-_9RB4cv4zJEp44Sbg

Earlier than persevering with, confirm the TXT report has been deployed. Relying on the DNS
supplier, this will likely take a while, from just a few seconds to a number of minutes. You possibly can
verify if it has completed deploying with support of on-line instruments, such because the Google
Admin Toolbox: https://toolbox.googleapps.com/apps/dig/#TXT/_acme-challenge.codeengine.instance.org.
Search for a number of bolded line(s) under the road ';ANSWER'. It ought to present the
worth(s) you have simply added.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Press Enter to Proceed

Let’s add the verification TXT information for each domains within the DNS as per the under:

codeengine.instance.org	TXT	Fq2wbN9mUSfnWZkGXyaEgVaOm-_9RB4cv4zJEp44Sbg

instance.org		TXT	DfjSDFFDbN9vccdSDnjnkSNSNKx-_9vccdSDnZvccdSDn

Now, it’s essential to create a TXT report with the above worth in your area’s DNS servers. The DNS servers on your area might need been offered by your area registrar or these will be hosted someplace else. After you add this DNS report, you may confirm it utilizing dig or nslookup:

% dig txt _acme-challenge.codeengine.instance.org. +quick
"Fq2wbN9mUSfnWZkGXyaEgVaOm-_9RB4cv4zJEp44Sbg"

After you press Enter or Return, it’s best to see one thing like the next:

Efficiently obtained certificates.
Certificates is saved at: /and so on/letsencrypt/stay/codeengine.instance.org/fullchain.pem
Secret is saved at:        /and so on/letsencrypt/stay/codeengine.instance.org/privkey.pem
This certificates expires on 2023-07-20.
These recordsdata might be up to date when the certificates renews.

NEXT STEPS:
- This certificates won't be renewed routinely. Autorenewal of --manual certificates requires using an authentication hook script (--manual-auth-hook) however one was not offered. To resume this certificates, repeat this similar certbot command earlier than the certificates's expiry date.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
When you like Certbot, please think about supporting our work by:
 * Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
 * Donating to EFF:                    https://eff.org/donate-le
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

You bought two recordsdata:

/and so on/letsencrypt/stay/codeengine.instance.org/fullchain.pem

That is your TLS certificates with full root-ca chain certificates. The contents must be one thing like this:

-----BEGIN CERTIFICATE-----
MIIFNDCCBBygAwIBAgISBOLyU
------
------
------
cRQJMEhg76fsO3txE+FiYruq9RUWhiF1myv4Q6W+CyBFC
Dfvp7OOGAN6dEOM4+qR9sdjoSYKEBpsr6GtPAQw4dy753ec5
-----END CERTIFICATE-----

/and so on/letsencrypt/stay/codeengine.instance.org/privkey.pem

That is the non-public key on your TLS certificates. The content material of the non-public key file must be one thing like the next:

-----BEGIN PRIVATE KEY-----
MIIEvwIBADANBgkqhkiG9w0BAQEF
------
------
------
BAZQ4dZS/TXFRMQcgNL3nWGk42YSOYAjqJNceX6rQMSoxDiCdb6e+
+pT6jcKsENz88M3dpNQNi1OSUQ==
-----END PRIVATE KEY-----

2. Add your area to Code Engine utility UI

Since you’ve TLS certificates and key obtainable, now you can proceed so as to add the customized area to the IBM Cloud Code Engine utility from the IBM Cloud console.

Go here and observe Initiatives > Your challenge identify > Purposes > Software identify > Area mappings tab
Choose the appliance for which you need to use a customized area.
Choose Area mappings from the highest bar menu.
Right here, it’s essential to click on on the blue button named Create below the part titled Customized area mappings.
A brand new setup wizard ought to open just like the screenshot above. It’s worthwhile to paste the contents from the file fullchain.pem within the textual content field titled Certificates chain and file privkey.pem to the textual content field titled Personal key.
Below the part titled Area identify and goal utility, kind the precise customized area hostname:
- Area identify: Kind “instance.org” on this editable textual content discipline.
- CNAME Goal: Pref-filled textual content must be there, which we have to create a CNAME report for this area identify.

instance.org			CNAME	customized.zx67dfvbl7l.us-south.codeengine.appdomain.cloud

codeengine.instance.org	CNAME	customized. zx67dfvbl7l.us-south.codeengine.appdomain.cloud

3. Create a CNAME report in DNS on your area identify

This is a vital step. Let’s create a CNAME report in your area’s DNS servers pointing to the worth from the CNAME goal field.

After you’ve created the CNAME report, proceed by choosing the Create button to complete creating the customized area identify mapping. This could take couple of minutes to be absolutely activated within the system.

If you wish to use your root area (instance.org) as a substitute of a subdomain like codeengine.instance.org, you could need to use the CNAME flattening function of IBM Cloud Web Companies. For extra particulars check with the hyperlinks under.

If all the things goes effective, it’s best to have the ability to entry your utility utilizing your customized area:

% curl -k https://instance.org 
Whats up World from:
. ___  __  ____  ____
./ __)/  (    (  __)
( (__(  O )) D ( ) _)
.___)__/(____/(____)
.____  __ _   ___  __  __ _  ____
(  __)(  (  / __)(  )(  ( (  __)
.) _) /    /( (_  )( /    / ) _)
(____)_)__) ___/(__)_)__)(____)

Some Env Vars:
--------------
CE_APP=application-27
CE_DOMAIN=us-south.codeengine.appdomain.cloud
CE_SUBDOMAIN=z87ya4p4l7l
HOME=/root
HOSTNAME=application-27-00004-deployment-6fff67f786-f82qm
K_REVISION=application-27-00004
PATH=/usr/native/sbin:/usr/native/bin:/usr/sbin:/usr/bin:/sbin:/bin
PORT=8080
PWD=/
SHLVL=1
z=Set env var 'SHOW' to see all variables

Congratulations, we’ve efficiently uncovered our IBM Cloud Code Engine utility through customized domains.