Skip to main content

Embedded cluster requirements

Review this page before deploying Chef 360 Platform with an embedded Kubernetes cluster. Use these requirements to confirm that your hosts, network, storage, domain name, and license meet the prerequisites for the embedded deployment.

The embedded cluster is a Chef-managed Kubernetes environment for Chef 360 Platform. Use this page to plan your deployment. For host details, see the Kubernetes and Linux host requirements reference.

Before you begin

  • Decide whether you need a single-node evaluation deployment or a multi-node production deployment.
  • Confirm that you have a valid Chef 360 Platform license.
  • Identify the Linux hosts that will run the embedded cluster.
  • Confirm that your organization can provide the required network access, storage, DNS, and firewall configuration.

Review the requirements

Review these requirements before you start the deployment. They apply to all embedded deployments. Then go to the section for your network model: internet-connected deployments or air-gapped deployments.

Licensing

You need a valid Chef 360 Platform license to install and run Chef 360 Platform.

Hardware

Chef 360 Platform supports single-node and multi-node deployments. Select a topology based on your availability and scalability requirements.

For production environments, run a benchmark test to determine your system’s requirements. The benchmark test should include the number of nodes you plan to enroll, job frequency, output size, job duration, and check-in frequency.

For deployment-specific sizing, also review the single-node and multi-node requirements:

Chef Declarative State Management

Starting with Chef 360 Platform 1.6.0, Declarative State Management (DSM) is included with Chef 360 Platform by default. The hardware requirements listed here include DSM.

If you’re upgrading from a version before 1.6.0, verify that your nodes meet the current requirements.

Single-node deployment

A single-node Chef 360 Platform deployment (hyperconverged non-HA) has the following minimum requirements. Adjust these values based on your specific usage patterns and workload. For sizing recommendations tailored to your environment, contact your Customer Architect or Customer Success Manager.

vCPUMemoryStorage
1632 GB200 GB

Multi-node deployment

All nodes must meet or exceed the requirements for their assigned role. Minimum node counts and node sizing requirements must both be satisfied. Using fewer nodes with larger specifications doesn’t replace the required node count. Node roles must be deployed exactly as defined for each topology.

These requirements support reliable operation and high availability of the platform.

Multi-node systems have the following minimum requirements:

TopologyRolesNodesvCPUMemory (GB)Disk (GB)
Hyperconverged-HAController + Frontend + Backend31632200
Tiered-HAController + Backend31632200
Frontend3 or more81650
Hyperscale-HAController341650
Frontend3 or more81650
Backend31632200

Node sizing requirements can vary based on workload characteristics, scale expectations, performance objectives, availability requirements, and integration patterns. The requirements documented here represent a baseline configuration. Work with a Chef 360 Platform Architect to validate and refine node sizing and ensure your deployment meets the specific needs of your environment.

For more information about cluster topologies and adding nodes, see Cluster management.

Embedded cluster storage

If the root filesystem can’t provide the required disk capacity, mount a separate filesystem at /var/lib/embedded-cluster on each applicable host before installing Chef 360 Platform. Size it to meet that host’s disk requirement in the hardware table.

File systems and storage

Chef 360 Platform has the following file system requirements:

  • A mounted XFS filesystem with the ftype=1 option. This is the default in recent RHEL versions.
  • The /var directory isn’t mounted with the noexec option.

Network ports

Chef 360 Platform uses the following network ports when deployed with the default configuration. Ensure these ports are open and accessible where applicable.

Ports for inbound connections:

PortDescription
22SSH access for server administration
30000Admin Console (HTTPS with a self-signed certificate). Not used in Bring Your Own Kubernetes (BYOK) deployments.
31000Chef 360 Platform web UI and API gateway
31050RabbitMQ service (AMQP or AMQP over TLS when TLS is enabled)
31101Mailpit web UI (optional; required only when using the bundled SMTP service)

Ports for outbound connections:

PortDescription
443Required for internet-connected deployments to access external services over HTTPS. Air-gapped deployments don’t require outbound internet access.

Multi-node cluster ports

In a multi-node deployment, hosts communicate with each other. Allow the following ports between cluster nodes:

ProtocolPortServiceDirectionNotes
TCP2380etcd peerscontroller <-> controller
TCP6443kube-apiserverworker, CLI => controllerAuthenticated Kube API using Kube TLS client certs and ServiceAccount tokens with RBAC
TCP179kube-routerworker <-> workerBGP routing sessions between peers
UDP4789Calicoworker <-> workerCalico VXLAN overlay
TCP10250kubeletcontroller, worker => hostAuthenticated kubelet API for the controller node kube-apiserver (and heapster or metrics-server add-ons) using TLS client certs
TCP9443k0s-apicontroller <-> controllerk0s controller join API, TLS with token auth
TCP8132konnectivityworker <-> controllerReverse tunnel between kube-apiserver and worker kubelets
TCP112keepalivedcontroller <-> controllerOnly required for control plane load balancing VRRP instances for IP address 224.0.0.18, a multicast IP address defined in RFC 3768

Allow all traffic to and from the podCIDR and serviceCIDR subnets on nodes with a worker role. These ports cover the k0s runtime and don’t include application ports.

For in-cluster networking, iptables, and firewalld guidance, see networking requirements.

Fully qualified domain name

Chef 360 Platform Server requires a fully qualified domain name (FQDN) that’s RFC 1123-compliant and registered with the Domain Name System (DNS). Confirm that the FQDN resolves from the workstations, user devices, and managed nodes that need to reach Chef 360 Platform.

Kubernetes and Linux host requirements

The embedded Kubernetes cluster uses k0s as its underlying runtime. Your Linux hosts need the kernel features required by k0s and Kubernetes.

For information about supported Linux kernel configurations, external runtime dependencies, and preflight checks, see Kubernetes and Linux requirements.

For a multi-node deployment, make sure each host has a unique machine ID. Review the machine ID requirements before creating hosts from a shared image.

Disaster recovery

Disaster recovery has the following requirements:

  • Chef 360 Platform 1.7.0 or later installed and running.

  • PostgreSQL backups configured for in-cluster PostgreSQL. This is required for disaster recovery. PostgreSQL RDS uses AWS-managed automated backups and snapshots instead.

  • S3-compatible object storage accessible to the Chef 360 Platform cluster. The following storage options are supported:

    • AWS S3
    • MinIO: Must be configured to use HTTP or HTTPS with a certificate issued by a publicly trusted certificate authority. MinIO with self-signed certificates isn’t supported.

In an air-gapped environment, your S3-compatible object storage must be accessible from within your virtual private cloud (VPC) without public internet access. Configure access using one of the following methods:

  • A VPC endpoint for S3 (recommended)
  • Custom network routing to S3

Verify that your IAM permissions and security group rules allow Chef 360 Platform to read from and write to the S3 bucket.

Internet-connected deployments

Internet-connected hosts download installation artifacts during installation. In addition to the shared requirements, allow outbound HTTPS access to these domains:

  • registry.chef360.chef.io
  • download.chef360.chef.io
  • proxy.chef360.chef.io
  • appservice.chef360.chef.io
  • index.docker.io
  • cdn.auth0.com
  • *docker.io
  • *docker.com

To install, go to deploy Chef 360 Platform with an embedded cluster.

Air-gapped deployments

If you’re deploying in an air-gapped environment, you need:

  • Jump host: An internet-connected workstation. Use this machine to download all required assets.
  • Air-gapped host: An air-gapped workstation that can receive file transfers from the jump host.

Air-gapped hosts don’t need outbound internet access. You don’t need to open the outbound port or allow access to the domains listed for internet-connected deployments. All other requirements and ports on this page still apply. To install, go to install Chef 360 Platform in an air-gapped environment.

Check whether this applies

Use these requirements when Chef 360 Platform provisions and manages Kubernetes as part of a Chef 360 Platform deployment. If your organization manages its own Kubernetes cluster, use the BYOK system requirements instead.

Review your plan

Before you start the deployment, verify each item:

  • You selected a single-node or multi-node deployment.
  • You have a valid Chef 360 Platform license.
  • Each Linux host meets the required CPU, memory, disk, and operating system requirements.
  • Each host has the required file systems and storage capacity.
  • For multi-node deployments, the required cluster ports are open between nodes.
  • The deployment FQDN is configured in DNS and resolves to the correct host or load balancer.
  • Each host in a multi-node deployment has a unique machine ID.
  • Your firewall allows traffic to the required Chef, registry, download, proxy, application service, and Docker Hub endpoints for an online installation.
  • You have planned backup storage and S3-compatible access if disaster recovery is required.
  • For internet-connected deployments, the outbound port in the port table is open for access to the Chef, registry, download, proxy, application service, and Docker Hub domains.
  • For air-gapped deployments, you have a jump host and an air-gapped host, and a way to transfer the air gap bundle between them.
  • You have access to the installation artifacts and the permissions required to install and configure Chef 360 Platform.

When you’ve completed every item, continue to deploy Chef 360 Platform with an embedded cluster.

Next steps

Thank you for your feedback!

×