Support boundaries ¶
This page describes what is within our scope of support for Kubernetes deployments, and what isn't.
Supported components ¶
Helm charts ¶
Helm is a Kubernetes package manager. It allows us to provide generic
YAML templates that you configure with the specific values for your environments.
As described in the Prerequisites, you are responsible for creating the components that are required by the product for your type of deployment. You need to supply the appropriate values to your specific
values.yaml file that is used for installation. We provide documentation for different configuration options in the Configuration guide and the Examples.
If you have followed our documentation on how to configure the Helm charts, and you're using correctly created components, we will then provide support if you encounter an error with installation post
Unsupported components ¶
The Prerequisites can be created in multiple ways. You are responsible for creating them correctly so that they can be used successfully with the Helm charts. Additional details on these prerequisites and their requirements below:
Kubernetes cluster ¶
You need to make sure that you have enough privileges to run the application and create all the necessary entities that the Helm charts require. There are also different Kubernetes flavours that might require specific knowledge of how to install the products in them. For example, OpenShift and Rancher have more strict rules regarding container permissions.
See examples of provisioning Kubernetes clusters on cloud-based providers.
Shared storage ¶
Kubernetes setup requires you to have shared storage if you want to have a clustered instance. It's completely up to you how you set up the shared storage. The main requirement is that this storage needs to be accessible from Kubernetes and needs to be accessible from multiple pods.
You can use a managed storage solution like EFS, Azure files, or some other dedicated solution that provides NFS-like access (e.g. dedicated NFS server, NetApp).
There is a large number of combinations and potential setup scenarios and we can't support all of them. Our Helm charts expect you to provide a persistent volume claim, or a similar accessible shared storage in the
You're required to configure the network access to the cluster. In Kubernetes, this usually means providing an ingress controller.
It is up to you to make sure that the network configuration doesn’t prevent nodes from communicating with each other and other components.
You also need to make sure that your instance is accessible to the users (DNS, firewalls, VPC config).
See an example of provisioning an NGINX Ingress controller.
values.yaml the database is provided as a connection string with the option to provide credentials and a driver. The database needs to be configured following product-specific requirements and needs to be accessible from Kubernetes.
See an example of provisioning databases on cloud-based providers.
Bamboo - custom remote agents ¶
If creating and using custom remote docker agents, you're required to ensure that they are configured, built and working as expected.
See an example of customizing a remote agent with bespoke capabilities.