This guide provides best practices for designing, implementing, testing, and deploying a Knative serving service. For more tips, see Migrating an Existing Service.
Writing effective services
This section describes general best practices for designing and implementing a Knative serving service.
Avoiding background activities
When an application running on Knative serving finishes handling a request, the container instance's access to CPU will be disabled or severely limited. Therefore, you should not start background threads or routines that run outside the scope of the request handlers.
Running background threads can result in unexpected behavior because any subsequent request to the same container instance resumes any suspended background activity.
Background activity is anything that happens after your HTTP response has been delivered. Review your code to make sure all asynchronous operations finish before you deliver your response.
If you suspect there may be background activity in your service that is not readily apparent you can check your logs: look for anything that is logged after the entry for the HTTP request.
Deleting temporary files
In the Cloud Run environment disk storage is an in-memory filesystem. Files written to disk consume memory otherwise available to your service, and can persist between invocations. Failing to delete these files can eventually lead to an out-of-memory error and a subsequent cold start.
Optimizing performance
This section describes best practices for optimizing performance.
Starting services quickly
Because container instances are scaled as needed, a typical method is to initialize the execution environment completely. This kind of initialization is called "cold start". If a client request triggers a cold start, the container instance startup results in additional latency.
The startup routine consists of:
- Starting the service
- Starting the container
- Running the entrypoint command to start your server.
- Checking for the open service port.
Optimizing for service startup speed minimizes the latency that delays a container instance from serving requests.
Using dependencies wisely
If you use a dynamic language with dependent libraries, such as importing modules in Node.js, the load time for those modules adds latency during a cold start. Reduce startup latency in these ways:
- Minimize the number and size of dependencies to build a lean service.
- Lazily load code that is infrequently used, if your language supports it.
- Use code-loading optimizations such as PHP's composer autoloader optimization.
Using global variables
In Knative serving, you cannot assume that service state is preserved between requests. However, Knative serving does reuse individual container instances to serve ongoing traffic, so you can declare a variable in global scope to allow its value to be reused in subsequent invocations. Whether any individual request receives the benefit of this reuse cannot be known ahead of time.
You can also cache objects in memory if they are expensive to recreate on each service request. Moving this from the request logic to global scope results in better performance.
Node.js
Python
Go
Java
Performing lazy initialization of global variables
The initialization of global variables always occurs during startup, which increases cold start time. Use lazy initialization for infrequently used objects to defer the time cost and decrease cold start times.
Node.js
Python
Go
Java
Optimizing concurrency
Knative serving instances can serve multiple requests simultaneously,
"concurrently", up to a configurable maximum concurrency.
This is different from Cloud Run functions, which uses concurrency = 1
.
You should keep the default maximum concurrency setting unless your code has specific concurrency requirements.
Tuning concurrency for your service
The number of concurrent requests that each container instance can serve can be limited by the technology stack and the use of shared resources such as variables and database connections.
To optimize your service for maximum stable concurrency:
- Optimize your service performance.
- Set your expected level of concurrency support in any code-level concurrency configuration. Not all technology stacks require such a setting.
- Deploy your service.
- Set Knative serving concurrency for your service equal or less than any code-level configuration. If there is no code-level configuration, use your expected concurrency.
- Use load testing tools that support a configurable concurrency. You need to confirm that your service remains stable under expected load and concurrency.
- If the service does poorly, go to step 1 to improve the service or step 2 to reduce the concurrency. If the service does well, go back to step 2 and increase the concurrency.
Continue iterating until you find the maximum stable concurrency.
Matching memory to concurrency
Each request your service handles requires some amount of additional memory. So, when you adjust concurrency up or down, make sure you adjust your memory limit as well.
Avoiding mutable global state
If you want to leverage mutable global state in a concurrent context, take extra steps in your code to ensure this is done safely. Minimize contention by limiting global variables to one-time initialization and reuse as described above under Performance.
If you use mutable global variables in a service that serves multiple requests at the same time, make sure to use locks or mutexes to prevent race conditions.
Container security
Many general purpose software security practices apply to containerized applications. There are some practices that are either specific to containers or that align with the philosophy and architecture of containers.
To improve container security:
Use actively maintained and secure base images such as Google base images or Docker Hub's official images.
Apply security updates to your services by regularly rebuilding container images and redeploying your services.
Include in the container only what is necessary to run your service. Extra code, packages, and tools are potential security vulnerabilities. See above for the related performance impact.
Implement a deterministic build process that includes specific software and library versions. This prevents unverified code from being included in your container.
Set your container to run as a user other than
root
with the DockerfileUSER
statement. Some container images may already have a specific user configured.
Automating security scanning
Enable vulnerability scanning for security scanning of container images stored in Artifact Registry.
You can also use Binary Authorization to ensure only secure container images are deployed.
Building minimal container images
Large container images likely increase security vulnerabilities because they contain more than what the code needs.
On Knative serving, the size of your container image does not affect cold start or request processing time and does not count towards the available memory of your container.
To build a minimal container, consider working from a lean base image such as:
Ubuntu is larger in size, but is a commonly used base image with a more complete out-of-box server environment.
If your service has a tool-heavy build process consider using multi-stage builds to keep your container light at run time.
These resources provide further information on creating lean container images:
- Kubernetes best practices: How and why to build small container images
- 7 best practices for building containers