> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/planning-and-installation.md). # Planning and Installation - [Prerequisites and compatibility](https://docs.weka.io/planning-and-installation/prerequisites-and-compatibility.md): Verify server, operating system, network, storage, and object store compatibility before installing WEKA. - [System installation on bare metal servers](https://docs.weka.io/planning-and-installation/bare-metal.md): Explore the automated tools and workflow paths for installing and configuring WEKA software on a group of bare metal servers in an on-premises environment. - [Plan hardware requirements](https://docs.weka.io/planning-and-installation/bare-metal/planning-a-weka-system-installation.md): Plan server, storage, network, and capacity requirements for a WEKA deployment. - [Obtain the installation packages](https://docs.weka.io/planning-and-installation/bare-metal/obtaining-the-weka-install-file.md): Register on get.weka.io and download the installation package for the selected installation path. - [Install WSA](https://docs.weka.io/planning-and-installation/bare-metal/install-the-weka-cluster-using-the-wsa.md): Use the WSA to simplify and accelerate WEKA software installation on bare metal servers. - [Install OS and WEKA software](https://docs.weka.io/planning-and-installation/bare-metal/manually-install-os-and-weka-on-servers.md): Install a supported operating system and the WEKA software on each bare metal server when using the manual installation path. - [Safe server shutdown](https://docs.weka.io/planning-and-installation/bare-metal/manually-install-os-and-weka-on-servers/safe-server-shutdown.md): Explore the systemd-based mechanism that allows a server to shut down safely. This feature is particularly valuable for converged servers that users might terminate abruptly. - [Prepare the system](https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts.md): Set the networking and other tasks before configuring the WEKA cluster. - [Broadcom adapter setup for WEKA clients](https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts/broadcom-adapter-setup-for-weka-system.md): Configure Broadcom network adapters for WEKA client connectivity. - [Enable the SR-IOV](https://docs.weka.io/planning-and-installation/bare-metal/setting-up-the-hosts/sr-iov-enablement.md): Enable SR-IOV on supported network adapters for WEKA. - [Configure the cluster with WEKA Configurator](https://docs.weka.io/planning-and-installation/bare-metal/configure-the-weka-cluster-using-the-weka-configurator.md): Detailed workflow for WEKA cluster installation in a multi-container backend architecture using the WEKA Configurator. - [Configure the cluster with Resources Generator](https://docs.weka.io/planning-and-installation/bare-metal/manually-configure-the-weka-cluster-using-the-resource-generator.md): Detailed workflow for manually configuring the WEKA cluster using the resource generator in a multi-container backend architecture. - [VLAN tagging in the WEKA system](https://docs.weka.io/planning-and-installation/bare-metal/manually-configure-the-weka-cluster-using-the-resource-generator/vlan-tagging-in-the-weka-system.md): WEKA tenant clusters use VLAN tagging to enable isolated network communication between clusters and their clients. - [Perform post-configuration](https://docs.weka.io/planning-and-installation/bare-metal/perform-post-configuration-procedures.md): Complete the required configuration tasks after creating a WEKA cluster. - [Add clients](https://docs.weka.io/planning-and-installation/bare-metal/adding-clients-bare-metal.md): Add clients to a bare-metal WEKA cluster. - [Cloud Deployment Manager Web (CDM Web) User Guide](https://docs.weka.io/planning-and-installation/weka-cdm-web-user-guide.md): Use Cloud Deployment Manager Web to plan and deploy WEKA infrastructure. - [WEKA installation on AWS](https://docs.weka.io/planning-and-installation/aws.md): Deploy WEKA on AWS with Terraform. For system engineers familiar with AWS and Terraform. - [Terraform-AWS-WEKA module description](https://docs.weka.io/planning-and-installation/aws/aws-weka-terraform-deployment-module-description.md): Review the Terraform AWS WEKA module structure, inputs, and deployment resources. - [Deployment on AWS using Terraform](https://docs.weka.io/planning-and-installation/aws/deployment-on-aws-using-terraform.md): Deploy WEKA on AWS using Terraform. - [Required services and supported regions](https://docs.weka.io/planning-and-installation/aws/required-services-and-supported-regions.md): Review AWS services and regions required for a WEKA Terraform deployment. - [Supported EC2 instance types using Terraform](https://docs.weka.io/planning-and-installation/aws/supported-ec2-instance-types.md): Select supported Amazon EC2 instance types for WEKA Terraform deployments. - [WEKA cluster auto-scaling in AWS](https://docs.weka.io/planning-and-installation/aws/weka-cluster-auto-scaling-in-aws.md): Configure AWS auto scaling for WEKA cluster resources. - [Detailed deployment tutorial: WEKA on AWS using Terraform](https://docs.weka.io/planning-and-installation/aws/detailed-deployment-tutorial-weka-on-aws-using-terraform.md): Deploy WEKA on AWS with Terraform using a complete guided workflow. - [WEKA installation on Azure](https://docs.weka.io/planning-and-installation/weka-installation-on-azure.md): Deploy WEKA on Azure with Terraform. For system engineers familiar with Azure and Terraform. - [Azure-WEKA deployment Terraform package description](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/azure-weka-terraform-package-description.md): Review the Azure WEKA Terraform package structure, inputs, and deployment resources. - [Deployment on Azure using Terraform](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/deployment-on-azure-using-terraform.md): Deploy WEKA on Azure using Terraform. - [Required services and supported regions](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/required-services-and-supported-regions.md): Review Azure services and regions required for a WEKA Terraform deployment. - [Supported virtual machine types](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/supported-virtual-machine-types.md): Select supported Azure virtual machine types for WEKA deployments. - [Auto-scale virtual machines in Azure](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/auto-scale-virtual-machines-in-azure.md): Configure Azure virtual machine scaling for a WEKA cluster. - [Add clients to a WEKA cluster on Azure](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/add-clients.md): Add WEKA clients to a WEKA cluster deployed on Azure. - [Troubleshooting](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/troubleshooting.md): Troubleshoot common WEKA deployment issues on Azure. - [Detailed deployment tutorial: WEKA on Azure using Terraform](https://docs.weka.io/planning-and-installation/weka-installation-on-azure/detailed-deployment-tutorial-weka-on-azure-using-terraform.md): Deploy WEKA on Azure using a guided Terraform workflow. - [WEKA installation on GCP](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp.md): Deploy WEKA on GCP with Terraform. For system engineers familiar with GCP and Terraform. - [WEKA project description](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/weka-project-description.md): Configure Google Cloud project resources required for a WEKA deployment. - [GCP-WEKA deployment Terraform package description](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/gcp-terraform-package-description.md): Review the GCP WEKA Terraform package structure, inputs, and deployment resources. - [Deployment on GCP using Terraform](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/deployment-on-gcp-using-terraform.md): Deploy WEKA on Google Cloud using Terraform. - [Required services and supported regions](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/required-services-and-supported-regions.md): Review Google Cloud services and regions required for a WEKA Terraform deployment. - [Supported machine types and storage](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/supported-machine-types-and-storage.md): Select supported Google Cloud machine types and storage for WEKA. - [Auto-scale instances in GCP](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/auto-scale-instances-in-gcp.md): Configure Google Cloud instance scaling for a WEKA cluster. - [Add clients to a WEKA cluster on GCP](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/add-clients.md): Add WEKA clients to a WEKA cluster deployed on Google Cloud. - [Troubleshooting](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/troubleshooting.md): Troubleshoot common WEKA deployment issues on Google Cloud. - [Detailed deployment tutorial: WEKA on GCP using Terraform](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/detailed-deployment-tutorial-weka-on-gcp-using-terraform.md): Deploy WEKA on Google Cloud using a guided Terraform workflow. - [Google Kubernetes Engine and WEKA over POSIX deployment](https://docs.weka.io/planning-and-installation/weka-installation-on-gcp/google-kubernetes-engine-and-weka-over-posix-deployment.md): A step-by-step guide to setting up Google Kubernetes Engine (GKE) with WEKA on Google Cloud Platform (GCP), enhancing storage and scalability for demanding Kubernetes workloads. - [WEKA installation on OCI](https://docs.weka.io/planning-and-installation/weka-installation-on-oci.md): Deploy WEKA on OCI bare-metal infrastructure with OCI-specific networking and configuration requirements. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.weka.io/planning-and-installation.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.