copyright | lastupdated | keywords | subcollection | ||
---|---|---|---|---|---|
|
2023-11-30 |
configmaps with code engine, secrets with code engine, key references with code engine, key-value pair with code engine, referencing secrets with code engine, referencing configmaps with code engine, configmaps, secrets, environment variables, key reference, references |
codeengine |
{{site.data.keyword.attribute-definition-list}}
{: #secretcm-reference}
In {{site.data.keyword.codeengineshort}}, after you create secrets and configmaps, the information that is stored as key-value pairs can be consumed by your app, job, or function workload as an environment variable by referencing the full secret or configmap or by referencing individual keys. {: shortdesc}
Working with secrets as environment variables is similar to working with configmaps as environment variables. When you work with secrets, the data is encoded.
Consider the following information when you update an app, job, or function that has an environment variable that references configmaps or secrets.
- When you update an app, job, or function that has an environment variable that fully references a configmap (or secret) to fully reference a different configmap (or secret), full references override other full references in the order in which they are set (the last referenced set overrides the first set).
- When you update an app, job, or function that has an environment variable that references a key in one configmap (or secret) to reference the same key in a different configmap (or secret), then the last referenced key is used.
- When you update an app, job, or function that has an environment variable that fully references a configmap (or secret) to add a reference to a specific key, then the specific key reference overrides the full configmap (or secret) reference. {: note}
For basic information about referencing configmaps or secrets with the CLI, see Referencing configmaps with the CLI and Referencing secrets with the CLI.
The following scenarios can be completed for secrets or configmaps.
{: #secretcm-reference-fullref-cli}
Secrets and configmaps are made up of key-value pairs. Environment variables are the result of providing an entry per key when referencing the full secret or configmap. If multiple secrets (or configmaps) contain the same named key, then you only get one of the keys in the referenced secret or configmap.
In this scenario, create a secret, which contains key-value pairs for a username and password, and then reference the full secret when you run a job. You can update the secret to add a key and then demonstrate the use of the new key in a job. While this scenario uses a secret, you can use the same steps to fully reference a configmap by substituting configmap
for secret
in the commands.
-
Create the
mydatabasesec
secret and specify the key-value pairs for a username and password by using the--from-literal
option.ibmcloud ce secret create -n mydatabasesec --from-literal username=reader --from-literal password=abcd
{: pre}
-
View details about the
mydatabasesec
secret by using thesecret get
command. The values for thepassword
andusername
keys of the secret are encoded.ibmcloud ce secret get -n mydatabasesec
{: pre}
Example output
Getting generic secret 'mydatabasesec'... OK Name: mydatabasesec ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 17s Created: 2020-10-14 14:07:59 -0400 EDT Data: --- password: YWJjZA== username: cmVhZGVy
{: screen}
-
Set an environment variable on a job to reference the full
mydatabasesec
secret. In this example, let's use the--env-from-secret PREFIX=NAME
option wherePREFIX=NAME
specifies to reference the full configmap where each key is prefixed withPREFIX
. By using theread_
prefix, each key is prefixed withread_
. Because thebusybox
image does not print any output by default, the-c env
option specifies to print all the environment variables in the container.ibmcloud ce job create -n demo -i busybox -c env --env-from-secret read_=mydatabasesec
{: pre}
Consider using a prefix to help make sure that all your environment variables in your job or app are unique. For example, if you have a secret with keys,
a
,b
, andc
, these environment variables display asa
,b
, andc
. However, if you add a prefix such asread_
, then the keys display with the prefix, such asread_a
,read_b
, andread_c
. Using a prefix also groups your environment variables in the referencing app, job, or jobrun, and helps you avoid duplicates of keys in configmaps or secrets. {: note} -
(Optional) View the details of the
demo
job. The output displays the full reference to themydatabasesec
secret.ibmcloud ce job get -n demo
{: pre}
Example output
Getting job 'demo'... OK Name: demo ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 6s Created: 2022-05-04T15:04:16-04:00 Commands: env Environment Variables: Type Name Value Secret full reference read_=mydatabasesec Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
-
Run a job that uses the configuration of the
demo
job.ibmcloud ce jobrun submit --name demo1 --job demo
{: pre}
-
Display the logs of the job run. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. In this example, display the logs of the
demo1
job run. Notice in the log output that the keys of the full secretmydatabasesec
are displayed with the prefixread_
. Secret values are added to the environment decoded.ibmcloud ce jobrun logs --jobrun demo1
{: pre}
Example output
Getting logs for all instances of job run 'demo1'... Getting jobrun 'demo1'... Getting instances of jobrun 'demo1'... [...] HOSTNAME=demo1-0-0 read_username=reader read_password=abcd JOB_INDEX=0 CE_SUBDOMAIN=8aaon2dfwa0 CE_JOBRUN=demo1 [...]
{: screen}
-
Update the
mydatabasesec
secret to add a key by using--from-file
option. This option uses the format--from-file FILE
or--from-file KEY=FILE
. In the following command,certificate
is the key andcert.pem
is the name of the file.ibmcloud ce secret update -n mydatabasesec --from-file certificate=cert.pem
{: pre}
-
View details about the updated
mydatabasesec
secret by using thesecret get
command. The secret now contains three keys,certificate
,password
, andusername
. Secret values are encoded.ibmcloud ce secret get -n mydatabasesec
{: pre}
Example output
Getting generic secret 'mydatabasesec'... OK Name: mydatabasesec ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 4m13s Created: 2020-10-14 13:35:43 -0400 EDT Data: --- certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tLS0tDQphc2RmO2Frc2pkZmxrYWpzZGZsa2phc2xka2ZqYWxza2RqZmxha3NqZGZsaw0KLS0tLS1FTkQgQ0VSVEZJQ0lBVEUtLS0tLS0tLS0t password: YWJjZA== username: cmVhZGVy
{: screen}
-
Run a job that uses the
demo
job. Previously, you referenced the full secretmydatabasesec
from thedemo
job. For a job to use the updated secret with the addedcertificate
key-value pair, submit a new job run. To update an app to use the updated secret, restart the app.ibmcloud ce jobrun submit --name demo2 --job demo
{: pre}
-
Display the logs of the job run by using the
ibmcloud ce jobrun logs
command. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. To display the logs of a specific instance of the job run, use the--instance
option with thejobrun logs
command. If needed, use thejobrun get --name demo2
command to display details of this job run, including the instances of the job run. In this example, display the logs of the running instance ofdemo2-0-0
wheredemo2
is the name of the job run,0
is thearrayindex
, and0
is theretryindex
. Notice in the output that thecertificate
,username
, andpassword
keys of the full secretmydatabasesec
are displayed. Secret values are added to the environment decoded.ibmcloud ce jobrun logs --instance demo2-0-0
{: pre}
Example output
Getting logs for job run instance 'demo2-0-0'... [...] read_certificate=-----BEGIN CERTIFICATE-------- asdf;aksjdflkajsdflkjasldkfjalskdjflaksjdflk -----END CERTFICIATE---------- read_password=abcd read_username=reader
{: screen}
{: #secretcm-reference-keyref-cli}
In this scenario, let's create a configmap that contains multiple key-value pairs and then reference specific keys in a job. While this scenario uses a configmap, you can use the same general steps to reference individual keys with a secret by substituting secret
for configmap
in the commands.
-
Create the
mydatabase
configmap and specify the key-value pairs for a name and a URL by using the--from-literal KEY=VALUE
option.ibmcloud ce configmap create -n mydatabasecm --from-literal name=myname --from-literal url=myurl
{: pre}
-
View details about the
mydatabasecm
configmap by using theconfigmap get
command.ibmcloud ce configmap get -n mydatabasecm
{: pre}
Example output
Getting configmap 'mydatabasecm'... OK Name: mydatabasecm ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 16s Created: 2020-10-14 13:31:19 -0400 EDT Data: --- name: myname url: myurl
{: screen}
-
Set an environment variable on a job to reference the
url
key in themydatabasecm
configmap. Use the--env-from-configmap NAME:KEY_A,KEY_B
option whereNAME:KEY_A
specifies to reference theKEY_A
of the configmap.ibmcloud ce job create --name keydemo --image busybox --command env --env-from-configmap mydatabasecm:url
{: pre}
-
Run a job that uses the
keydemo
job.ibmcloud ce jobrun submit --name keydemo1 --job keydemo
{: pre}
-
Display the logs of the job run by using the
ibmcloud ce jobrun logs
command. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. To display the logs of a specific instance of the job run, use the--instance
option with thejobrun logs
command. If needed, use thejobrun get --name keydemo1
command to display details of this job run, including the instances of the job run. Notice in the output thaturl
is the only referenced key and that thename
key is not referenced by the job.ibmcloud ce jobrun logs --instance keydemo1-0-0
{: pre}
Example output
Getting logs for job run instance 'keydemo1-0-0'... [...] url=myurl [...]
{: screen}
{: #secretcm-reference-overfull-cli}
You can override referenced secrets and configmaps. The following scenarios can be completed for secrets or configmaps.
{: #secretcm-reference-overfull-withfull-cli}
In this scenario, let's create a new mydatabasesec-writer
secret with the username
and password
keys and then override username
and password
keys in the previously created mydatabasesec
secret. The mydatabasesec
secret contains the username=reader
and password=abcd
keys.
{: shortdesc}
Full references override other full references in the order in which they are set (the last referenced set overrides the first set).
-
Set an environment variable on the
writerjob
job to reference the fullmydatabasesec
secret, which was created previously. Themydatabasesec
secret contains theusername=reader
andpassword=abcd
keys.ibmcloud ce job create -n writerjob -i busybox -c env --env-from-secret mydatabasesec
{: pre}
-
(Optional) View the details of the
writerjob
job. The output displays the full reference to themydatabasesec
secret.ibmcloud ce job get -n writerjob
{: pre}
Example output
Getting job 'writerjob'... OK Name: writerjob ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 17s Created: 2021-02-12T07:12:08-06:00 [...] Commands: env Environment Variables: Type Name Value Secret full reference mydatabasesec Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
-
Run a job that uses the
writerjob
job.ibmcloud ce jobrun submit --name writerjob1 --job writerjob
{: pre}
-
Display the logs of the job run. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. In this example, display the logs of the
writerjob1
job run. Notice in the output that theusername
andpassword
keys of the full secretmydatabasesec
are displayed. Secret values are added to the environment decoded.ibmcloud ce jobrun logs --jobrun writerjob1
{: pre}
Example output
Getting jobrun 'writerjob1'... Getting instances of jobrun 'writerjob1'... Getting logs for all instances of job run 'writerjob1'... OK [...] certificate=-----BEGIN CERTIFICATE-------- asdf;aksjdflkajsdflkjasldkfjalskdjflaksjdflk -----END CERTFICIATE---------- password=abcd username=reader [...]
{: screen}
-
Create the
mydatabasesec-writer
secret and specify the key-value pairs for a username and password by using the--from-literal
option.ibmcloud ce secret create --name mydatabasesec-writer --from-literal username=writer --from-literal password=wxyz
{: pre}
-
View details about the
mydatabasesec-writer
secret by using thesecret get
command. The values for thepassword
andusername
keys of the secret are encoded.ibmcloud ce secret get -n mydatabasesec-writer
{: pre}
Example output
Getting generic secret 'mydatabasesec-writer'... OK Name: mydatabasesec-writer ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 14s Created: 2020-10-14 13:44:16 -0400 EDT Data: --- password: d3h5eg== username: d3JpdGVy
{: screen}
-
Update the
writerjob
job to reference the fullmydatabasesec-writer
secret and use thewrite_
prefix.ibmcloud ce job update --name writerjob --env-from-secret write_=mydatabasesec-writer
{: pre}
-
(Optional) View details of the updated
writerjob
job. The job fully references themydatabasesec
and themydatabase-writer
secrets.ibmcloud ce job get -n writerjob
{: pre}
Example output
Getting job 'writerjob'... OK Name: writerjob ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 4m2s Created: 2021-02-12T07:12:08-06:00 [...] Commands: env Environment Variables: Type Name Value Secret full reference mydatabasesec Secret full reference write_=mydatabasesec-writer Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
-
Run a job that uses the
writerjob
job. Because thewriterjob
job was updated to reference both themydatabasesec
secret and themydatabasesec-writer
secret and both of these secrets include keys forusername
andpassword
, the last referenced full secretmydatabasesec-writer
overrides themydatabasesec
secret.For a job run to use the updated configuration of a job with the updates to its fully referenced secrets, run a new job. To update an app to use the updated secret, restart the app.
ibmcloud ce jobrun submit --name writerjob2 --job writerjob
{: pre}
-
Display the logs of the job run by using the
ibmcloud ce jobrun logs
command. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. To display the logs of all the instances of a job, use the--jobrun
option with thejobrun logs
command. To display the logs of a specific instance of the job run, use the--instance
option with thejobrun logs
command. If needed, use thejobrun get --name writerjob2
command to display details of this job run, including the instances of the job run. Notice in the output that theusername
andpassword
keys of themydatabasesec-writer
secret overrode the keys of themydatabasesec
secret. Also, in the log output, the keys of the full secretmydatabasesec-writer
are displayed with the prefixwrite_
.Secret values are added to the environment decoded.ibmcloud ce jobrun logs --instance writerjob2-0-0
{: pre}
Example output
Getting logs for job run instance 'writerjob2-0-0'... [...] certificate=-----BEGIN CERTIFICATE-------- asdf;aksjdflkajsdflkjasldkfjalskdjflaksjdflk -----END CERTFICIATE---------- password=abcd username=reader write_password=wxyz write_username=writer [...]
{: screen}
{: #secretcm-reference-overfull-withkey-cli}
References to a key in a secret or configmap always overrides a full reference to a secret or configmap when the key that is used resides in a fully referenced secret or configmap, without regard for order. {: shortdesc}
In this scenario, let's use the previously created mydatabasesec
and mydatabasesec-writer
secrets and reference keys within the secrets from a job.
-
Set an environment variable on a
writerpic
job to reference specific keys in themydatabasesec
andmydatabasesec-writer
secrets. Themydatabasesec
secret contains theusername=reader
,password=abcd
, andcertificate=cert.pem
keys. Themydatabasesec-writer
secret contains theusername=writer
andpassword=wxyz
keys.ibmcloud ce job create -n writerpick -i busybox -c env --env-from-secret mydatabasesec-writer:username --env-from-secret mydatabasesec-writer:password --env-from-secret mydatabasesec
{: pre}
-
(Optional) View the details of the
writerpick
job. The output displays the full reference to themydatabasesec
secret and the key reference to thepassword
andusername
keys of themydatabasesec-writer
secret.ibmcloud ce job get -n writerpick
{: pre}
Example output
Getting job 'writerpick'... OK Name: writerpick ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 107s Created: 2021-02-12T07:16:46-06:00 [...] Commands: env Environment Variables: Type Name Value Secret full reference mydatabasesec Secret key reference password mydatabasesec-writer.password Secret key reference username mydatabasesec-writer.username Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
-
Run a job that uses the
writerpick
job.ibmcloud ce jobrun submit --name writerpick1 --job writerpick
{: pre}
-
Display the logs of the
writerpick1
job run by using theibmcloud ce jobrun logs
command. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. To display the logs of a specific instance of the job run, use the--instance
option with thejobrun logs
command. If needed, use thejobrun get --name writerpick1
command to display details of this job run, including the instances of the job run. Because thewriterpick
job was updated to reference specific keys in themydatabasesec-writer
secret and to reference the fullmydatabasesec
secret, the reference to theusername
andpassword
keys in themydatabasesec-writer
secret overrides the reference to the full secret. Secret values are added to the environment decoded.ibmcloud ce jobrun logs --instance writerpick1-0-0
{: pre}
Example output
Getting logs for job run instance 'writerpick1-0-0'... [...] username=writer certificate=-----BEGIN CERTIFICATE-------- asdf;aksjdflkajsdflkjasldkfjalskdjflaksjdflk -----END CERTFICIATE---------- password=wxyz [...]
{: screen}
{: #secretcm-reference-overkey-withkey-cli}
You can update the reference to a specific key in a secret or configmap and override the value with a new value. {: shortdesc}
In this scenario, let's use the previously created mydatabasecm
configmap, which contains the url:myurl
key to update the value of the key.
-
Set an environment variable on a
keyref
job to reference a specific key in themydatabasecm
configmap.ibmcloud ce job create -n keyref -i busybox -c env --env-from-configmap mydatabasecm:url
{: pre}
-
(Optional) View the details of the
keyref
job. The output displays the key reference to theurl
key in themydatabasecm
configmap.ibmcloud ce job get -n keyref
{: pre}
Example output
Getting job 'keyref'... OK Name: keyref ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 65s Created: 2021-02-12T07:18:44-06:00 [...] Commands: env Environment Variables: Type Name Value ConfigMap key reference url mydatabasecm.url Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
-
Run a job that uses the
keyref
job.ibmcloud ce jobrun submit --name keyref1 --job keyref
{: pre}
-
Display the logs of a running instance of the
keyref1
job run by using theibmcloud ce jobrun logs
command. You can display logs of all the instances of a job run or display logs of a specific instance of a job run. To display the logs of a specific instance of the job run, use the--instance
option with thejobrun logs
command. If needed, use thejobrun get --name keyref1
command to display details of this job run, including the instances of the job run. The job run used theurl=myurl
key reference.ibmcloud ce jobrun logs --instance keyref1-0-0
{: pre}
Example output
Getting logs for job run instance 'keyref1-0-0'... [...] url=myurl [...]
{: screen}
-
Update the
keyref
job to override theurl=myurl
with a new key. Use the--env
option to update theurl
key. The--env
option on thejob update
command sets environment variables for the job inNAME=VALUE
format.ibmcloud ce job update --name keyref --env url=newurl
{: pre}
-
(Optional) View the details of the
keyref
job. The output displays the key reference to theurl
key in themydatabasecm
configmap.ibmcloud ce job get -n keyref
{: pre}
Example output
Getting job 'keyref'... OK Name: keyref ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 3m6s Created: 2021-02-12T07:18:44-06:00 Commands: env Environment Variables: Type Name Value Literal url newurl Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
{: #secretcm-reference-fullremove-cli}
You can remove a fully referenced secret or configmap from a job or app.
{: shortdesc}
In this scenario, let's remove the fully referenced mydatabasesec
secret from the demo
job.
-
Update the
demo
job to remove the reference to themydatabasesec
secret.ibmcloud ce job update -n demo --env-from-secret-rm mydatabasesec
{: pre}
-
View the details of the
demo
job. The output illustrates that the reference to themydatabasesec
secret is removed.ibmcloud ce job get -n demo
{: pre}
Example output
Getting job 'demo'... OK Name: demo ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 19m Created: 2021-02-12T07:05:23-06:00 [...] Commands: env Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}
{: #secretcm-reference-keyremove-cli}
You can remove a referenced key in a secret or configmap from a job or app.
{: shortdesc}
In this scenario, let's remove the url
key from the keyref
job.
Even though the --env-from-configmap
option was used on a job to reference the url
key in the mydatabasecm
configmap, you can use the --env-rm
option to remove individual keys. You can use the --env-rm
option with the job update
or app update
commands to remove key references regardless of whether the keys are individual key references in a secret or configmap, or whether the keys were directly set on a job or app with the --env
option.
{: tip}
-
Update the
keydef
job to remove the reference to theurl
key.ibmcloud ce job update --name keyref --env-rm url
{: pre}
-
View the details of the
keyref
job. The output illustrates that the reference to theurl
key is removed.ibmcloud ce job get -n keyref
{: pre}
Example output
Getting job 'keyref'... OK Name: keyref ID: abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f Project Name: myproject Project ID: 01234567-abcd-abcd-abcd-abcdabcd1111 Age: 6m27s Created: 2021-02-12T07:18:44-06:00 [...] Commands: env Image: busybox Resource Allocation: CPU: 1 Memory: 4G Runtime: Mode: task Array Indices: 0 Array Size: 1 Max Execution Time: 7200 Retry Limit: 3
{: screen}