Updating your app

What if I want to redeploy my application without changing configuration settings?

You can always deploy your application with configuration changes by changing a configuration value and deploying the application.

However, you might want to redeploy an application revision without changing your application configuration settings. Perhaps your referenced container image is changed, and you want your application revision to use the updated container image. Or, perhaps you want your application to reference a secret or configmap, which contains updated content values.

For these scenarios, from the console, you can click Redeploy from the Configuration tab of your application page, without changing your app configuration. With the CLI, use the ibmcloud ce app update command.

Updating your app from the console

Update the application that you created in Deploying an application from a public registry from the console to add an environment variable.

1. Navigate to your application page. One way to navigate to your application page is to
   • Locate the Code Engine Projects page.
   • Click the name of your project to open the Overview page.
   • Click Applications to open a list of your applications. Click the name of your application to open its application page.
2. From the application page, you can view information about the running instances of your application and its revisions, configuration details, and endpoint settings of the app. Click the name of the application revision that you want to work with to open the configuration summary for that revision. Or, you can click the Configuration tab to open the configuration summary for the latest application revision.
3. From the Configuration tab, click the Environment variables tab.
4. Click Add environment variable. Define this environment variable as a literal value. Enter TARGET for name and Stranger for value. Click Add.
5. Click Deploy to save your change and deploy the application revision.
6. After the application status changes to Ready, you can test the application revision. Click Test application and then click Send request in the Test application pane. To open the application in a web page, click Application URL. For this app, Hello Stranger is displayed.

In this example, you updated environment variables for an app. You can also update other configuration settings for your app, including referencing a different image or different image build from the Code tab. From the Resources & scaling tab, you can update memory and application scaling settings for your app. From the Environment variables tab, you can add or update environment variables for your app. From the Image start options tab, you can add or update command and arguments to override settings within your container image, or work with liveness and readiness probes.

Updating your app to use project-only endpoints from the console

By default, when you deploy an app, the app deploys such that it can receive requests from the public internet, from a private network, or from components within the project. Let's change the visibility of this app such that it is accessed only by other Code Engine resources that are running in the same Code Engine environment. Use the Domain mappings tab to change the visibility of an app.

1. Navigate to your application page. One way to navigate to your application page is to

   • Locate the Code Engine Projects page.
   • Click the name of your project to open the Overview page.
   • Click Applications to open a list of your applications. Click the name of your application to open its application page.

2. From the application page, you can view information about the running instances of your application and its revisions, configuration details, and endpoint settings of the app. Click the Domain mappings tab to open the endpoint visibility settings for the application.

3. From the Domain mappings tab, notice the available URLs for your application. When Public is selected, you can view the public and the internal system domain mapping URL for the application. When No external system domain mapping is selected, this application is no longer accessible from the public internet and network access is only possible from components within this project.

   When you change the visibility of your app, the change is effective immediately. It is important to consider the impact of the change for your active users or integrations as well as any security implications. You can change the visibility setting as needed.

Updating your app to use private endpoints from the console

By default, when you deploy an app, the app deploys such that it can receive requests from the public internet, from a private network, or from components within the project. Let's change the visibility of this app such that it is accessed only by other Code Engine resources that are running in the same project and from the private network by using Virtual Private Endpoints. Use the Domain mappings tab to change the visibility of an app.

1. Navigate to your application page. One way to navigate to your application page is to

   • Locate the Code Engine Projects page.
   • Click the name of your project to open the Overview page.
   • Click Applications to open a list of your applications. Click the name of your application to open its application page.

2. From the application page, you can view information about the running instances of your application and its revisions, configuration details, and endpoint settings of the app. Click the Domain mappings tab to open the endpoint visibility settings for the application.

3. From the Domain mappings tab, notice the available URLs for your application. When Private is selected, this application is no longer accessible from the public internet and network access is only possible from components within this project (cluster-local) and from the private network.

   Click Private to change the endpoint visibility of the app. The available URLs for your endpoint definition are displayed for the private and project-only URLs.

4. To access your app securely by using a Virtual Private Endpoint (VPE), follow the instructions for Using your VPE to access an app to set up the VPE to access your app.

If you set your application for visibility = private, then you can only test your application through the virtual private endpoint from within your Virtual Private Cloud (VPC).

By changing the visibility of your app, the change is effective immediately. It is important to consider the impact of the change for your active users or integrations as well as any security implications. You can change the visibility setting as needed.

Updating your app with the CLI

To update your app with the CLI, use the app update command. This command requires the name of the app that you want to update and also allows other optional arguments. For a complete listing of options, see the ibmcloud ce app update command.

Update the application that you created in Deploying an application with the CLI to add an environment variable.

The sample icr.io/codeengine/hello image reads the environment variable TARGET, and prints Hello ${TARGET}. If this environment variable is empty, Hello World is returned. The following example updates the app to modify the value of the TARGET environment variable to Stranger. For more information about the code that is used for this example, see hello.

1. Run the application update command. For example,

   ibmcloud ce application update -n myapp --env TARGET=Stranger
   

   Example output

   Updating application 'myapp' to latest revision.
   [...]
   Run 'ibmcloud ce application get -n myapp' to check the application status.
   OK
   
   https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud    
   

2. Run the application get command to display the status of your app, including the latest revision information.

   ibmcloud ce application get --name myapp  
   

   Example output

   [...]
   Name:          myapp
   [...]
   URL:           https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
   Cluster Local URL:  http://myapp.4svg40kna19.svc.cluster.local
   Console URL:   https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
   
   Environment Variables:
   Type     Name    Value
   Literal  TARGET  Stranger
   Image:                  icr.io/codeengine/hello
   Resource Allocation:
   CPU:                1
   Ephemeral Storage:  400M
   Memory:             4G
   
   Revisions:
   myapp-hc3u8-2:
       Age:                82s
       Traffic:            100%
       Image:              icr.io/codeengine/hello (pinned to f0dc03)
       Running Instances:  1
   
   Runtime:
   Concurrency:    100
   Maximum Scale:  10
   Minimum Scale:  0
   Timeout:        300
   
   Conditions:
   Type                 OK    Age  Reason
   ConfigurationsReady  true  75s
   Ready                true  62s
   RoutesReady          true  62s
   
   Events:
   Type    Reason   Age    Source              Messages
   Normal  Created  2m11s  service-controller  Created Configuration "myapp"
   Normal  Created  2m11s  service-controller  Created Route "myapp"
   
   Instances:
   Name                                       Revision       Running  Status       Restarts  Age
   myapp-hc3u8-1-deployment-65cf8cd4f5-jx8b8  myapp-hc3u8-1  1/2      Terminating  0         2m10s
   myapp-hc3u8-2-deployment-7f98b679d5-2hskr  myapp-hc3u8-2  2/2      Terminating  0         85s
   

   From the output in the Revisions section, you can see the latest application revision of the myapp service. Also, notice that 100% of the traffic to the application is running the latest revision of the app.

3. Call the application.

   curl https://myapp.4svg40kna19.us-south.codeengine.appdomain.cloud
   

   Example output

   Hello Stranger
   

   From the output of this command, you can see the updated app now returns Hello Stranger.

4. Use the ibmcloud ce revision list command to display all your app revisions. Use this information to help you manage your app revisions as Code Engine has a quota for the number of app revisions in a project.

   In the following revision list output, notice that Code Engine retains only the latest inactive revision of your application in addition to your active app revision. Older revisions are deleted.

   ibmcloud ce revision list 
   

   Example output

   Listing all application revisions...
   OK
   
   Name                   Application      Status  URL  Latest  Tag  Traffic  Age    Conditions  Reason
   myapp-hc3u8-4           myapp            Ready                            2d15h    3 OK / 4
   myapp-hc3u8-5           myapp            Ready        true         100%    2d8h    3 OK / 4  
   myapp2-vjfqt-1          myapp2           Ready        true         100%      3d    3 OK / 4
   myhelloapp-tv368-3      myhelloapp       Ready                              16d    3 OK / 4
   myhelloapp-tv368-4      myhelloapp       Ready        true         100%     16d    3 OK / 4
   newapp-mytest-00008     newapp-mytest    Ready                              4d17h  3 OK / 4
   newapp-mytest-00009     newapp-mytest    Ready        true         100%     2d20h  3 OK / 4
   

You can manage your app revisions by using the ibmcloud ce revision get command to display details of an app revision and the ibmcloud ce revision delete command to remove revisions that you don't want to keep. You can also use the ibmcloud ce revision logs command to view logs of application revision instances. Use the ibmcloud ce revision events command to display system events of application revision instances.

Updating your app to use project-only endpoints with the CLI

By default, when you deploy an app, the app deploys such that it can receive requests from the public internet, from a private network, or from components within the project. To change the visibility of your app such that it is accessed only by other Code Engine resources that are running in the same project, use the --visibility=project option with the ibmcloud ce app update or ibmcloud ce app create command.

In this scenario, update the application that you created in Deploying an application with the CLI to change the visibility of the app to use a project endpoint.

1. Run the application update command. For example,

   ibmcloud ce application update -n myapp --visibility=project
   

   Example output

   Updating application 'myapp' to latest revision.
   [...]
   Run 'ibmcloud ce application get -n myapp' to check the application status.
   OK
   
   http://myapp.4svg40kna19.svc.cluster.local   
   

2. Run the application get command to display the status of your app, including the latest revision information.

   ibmcloud ce application get --name myapp  
   

   Example output

   [...]
   Name:          myapp
   [...]
   URL:           http://myapp.4svg40kna19.svc.cluster.local
   Cluster Local URL:  http://myapp.4svg40kna19.svc.cluster.local
   Console URL:   https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
   
   Environment Variables:
   Type     Name    Value
   Literal  TARGET  Stranger
   Image:                  icr.io/codeengine/hello
   Resource Allocation:
   CPU:                1
   Ephemeral Storage:  400M
   Memory:             4G
   
   Revisions:
   myapp-hc3u8-2:
       Age:                82s
       Traffic:            100%
       Image:              icr.io/codeengine/hello (pinned to f0dc03)
       Running Instances:  1
   
   Runtime:
   Concurrency:    100
   Maximum Scale:  10
   Minimum Scale:  0
   Timeout:        300
   
   Conditions:
   Type                 OK    Age  Reason
   ConfigurationsReady  true  75s
   Ready                true  62s
   RoutesReady          true  62s
   
   Events:
   Type    Reason   Age    Source              Messages
   Normal  Created  2m11s  service-controller  Created Configuration "myapp"
   Normal  Created  2m11s  service-controller  Created Route "myapp"
   
   Instances:
   Name                                       Revision       Running  Status       Restarts  Age
   myapp-hc3u8-1-deployment-65cf8cd4f5-jx8b8  myapp-hc3u8-1  1/2      Terminating  0         2m10s
   myapp-hc3u8-2-deployment-7f98b679d5-2hskr  myapp-hc3u8-2  2/2      Terminating  0         85s
   

   From the output in the Revisions section, you can see the latest application revision of the myapp service. Also, notice that 100% of the traffic to the application is running the latest revision of the app.

Now that you set --visibility=project on your application, this application is no longer accessible from the public internet and network access is only possible from components within this project (cluster-local).

Updating your app to use private endpoints with the CLI

By default, when you deploy an app, the app deploys such that it can receive requests from the public internet, from a private network, or from components within the project. You can set the endpoint visibility for your app such that it is deployed with a private endpoint. Setting a private endpoint means that your app is not accessible from the public internet and network access is only possible from other IBM Cloud services from virtual private endpoints (VPC) or Code Engine components that are running in the same project (cluster-local).

To change the visibility of your app such that it is accessed only with a private endpoint, use the --visibility=private option with the ibmcloud ce app update or ibmcloud ce app create command.

You can only use your VPE to access your app with a private endpoint if your selected project supports application private visibility. To confirm if the project supports application private visibility, use the ibmcloud ce project get command to verify the output for Application Private Visibility Supported is set to true.

In this scenario, update the application that you created in Deploying an application with the CLI to change the visibility of the app to use a private endpoint.

1. Confirm that the existing project supports applications with private visibility. Use the ibmcloud ce project get command to verify the output for Application Private Visibility Supported is set to true. If the value is false, contact IBM support to enable this capability within your existing project.

   ibmcloud ce project get -n myproject
   

   Example output

   Getting project 'myproject'...
   OK
   
   Name:                                      myproject  
   ID:                         abcdabcd-abcd-abcd-abcd-f1de4aab5d5d
   Status:                                    active  
   Enabled:                                   true  
   Application Private Visibility Supported:  true  
   Selected:                                  true  
   Region:                                    us-south 
   Resource Group:             default
   Service Binding Service ID: ServiceId-1234abcd-abcd-abcd-1111-1a2b3c4d5e6f
   Age:                        52d 
   Created:                                   Tue, 28 Sep 2021 05:12:16 -0500  
   Updated:                                   Tue, 28 Sep 2021 05:12:19 -0500  
   
   Quotas:    
   Category                                  Used  Limit  
   App revisions                             1     60  
   Apps                                      1     20  
   Build runs                                1     100  
   Builds                                    2     100  
   Configmaps                                2     100  
   CPU                                       0     64  
   Ephemeral storage                         0     256G  
   Instances (active)                        0     250  
   Instances (total)                         0     2500  
   Job runs                                  0     100  
   Jobs                                      0     100  
   Memory                                    0     256G  
   Secrets                                   6     100  
   Subscriptions (cron)                      0     100  
   Subscriptions (IBM Cloud Object Storage)  0     100  
   Subscriptions (Kafka)                     0     100
   

2. If Application Private Visibility Supported is true, then you can update your app to use private endpoints. Run the application update command. For example,

   ibmcloud ce application update -n myapp --visibility=private
   

   Example output

   Updating application 'myapp' to latest revision.
   [...]
   Run 'ibmcloud ce application get -n myapp' to check the application status.
   OK
   
   https://myapp.4svg40kna19.private.us-south.codeengine.appdomain.cloud
   

3. Run the application get command to display the status of your app, including the latest revision information.

   ibmcloud ce application get --name myapp  
   

   Example output

   [...]
   Name:          myapp
   [...]
   URL:           https://myapp.4svg40kna19.private.us-south.codeengine.appdomain.cloud
   Cluster Local URL:  http://myapp.4svg40kna19.svc.cluster.local
   Console URL:   https://cloud.ibm.com/codeengine/project/us-south/01234567-abcd-abcd-abcd-abcdabcd1111/application/myapp/configuration
   
   Environment Variables:
   Type     Name    Value
   Literal  TARGET  Stranger
   Image:                  icr.io/codeengine/hello
   Resource Allocation:
   CPU:                1
   Ephemeral Storage:  400M
   Memory:             4G
   
   Revisions:
   myapp-hc3u8-2:
       Age:                82s
       Traffic:            100%
       Image:              icr.io/codeengine/hello (pinned to f0dc03)
       Running Instances:  1
   
   Runtime:
   Concurrency:    100
   Maximum Scale:  10
   Minimum Scale:  0
   Timeout:        300
   
   Conditions:
   Type                 OK    Age  Reason
   ConfigurationsReady  true  75s
   Ready                true  62s
   RoutesReady          true  62s
   
   Events:
   Type    Reason   Age    Source              Messages
   Normal  Created  2m11s  service-controller  Created Configuration "myapp"
   Normal  Created  2m11s  service-controller  Created Route "myapp"
   
   Instances:
   Name                                       Revision       Running  Status       Restarts  Age
   myapp-hc3u8-1-deployment-65cf8cd4f5-jx8b8  myapp-hc3u8-1  1/2      Terminating  0         2m10s
   myapp-hc3u8-2-deployment-7f98b679d5-2hskr  myapp-hc3u8-2  2/2      Terminating  0         85s
   

   From the output in the Revisions section, you can see the latest application revision of the myapp service. Also, notice that 100% of the traffic to the application is running the latest revision of the app.

4. Set up your VPE to access your app with a private endpoint.

Updating an app to reference a different image

You can update your app to reference a different image.

The image that is associated with your specific application revision has a unique container registry digest, and Code Engine uses this digest for the life of your application revision. If you create a newer version of an image with the same tag as the original image, the original image is overwritten in the container registry and becomes untagged. The newer image is tagged, and this newer image has a different digest. Your Code Engine application does not use this newer image, because the newer image has a different digest than the image that is referenced by the application revision. Code Engine can still create new instances of the application revision as long as the untagged image, which was referenced originally, still exists. For more information, see Why can't Code Engine pull an image?