README.md

DAOS on GCP

Distributed Asynchronous Object Storage (DAOS) on Google Cloud Platform (GCP)

This repository contains:

• Terraform modules for deploying DAOS Server and Client instances on GCP
• Scripts used to build DAOS images with Cloud Build and Packer
• Examples that demonstrate how to use the DAOS Terraform modules
• Documentation for deploying DAOS on GCP

Pre-Deployment

In order to deploy DAOS on GCP there are several steps that are required to prepare your project.

For instructions, see the Pre-Deployment Guide

As an alternative to viewing the guide as a standalone document, you can view it as an in-context tutorial in Cloud Shell by clicking the button below.

Deployment

After completing the steps in the Pre-Deployment Guide you will be ready to deploy DAOS.

To deploy DAOS on GCP you may choose one of the following deployment paths.

1. Cloud HPC Toolkit

   Cloud HPC Toolkit is open-source software offered by Google Cloud which makes it easy for you to deploy high performance computing (HPC) environments. It is designed to be highly customizable and extensible, and intends to address the HPC deployment needs of a broad range of use cases.

   The community examples in the Cloud HPC Toolkit use the DAOS modules in this repository.

   For documentation, see the Cloud HPC Toolkit Overview

   Prepare to use the Cloud HPC Toolkit

   • Dependencies

     If you are using Cloud Shell, the dependencies are already installed.

     If you are not using Cloud Shell, you will need to install a few dependencies.

     See Install dependencies

   • Configure Environment

     Before you can deploy DAOS with the Cloud HPC Toolkit you will need to complete some configuration steps.

     See Configure your environment.

   Deploy DAOS with the Cloud HPC Toolkit

   For instructions on how to deploy the community examples, see

   • DAOS Cluster
   • DAOS Server with Slurm Cluster

2. Deploy DAOS with the DAOS cluster example

   The terraform/examples/daos_cluster example demonstrates how to use the DAOS modules in a Terraform configuration to deploy a DAOS cluster consisting of servers and clients.

   To deploy the example, see Deploy the DAOS Cluster Example.

   As an alternative to viewing the instructions in Deploy the DAOS Cluster Example as a standalone document, you can view it as an in-context tutorial in Cloud Shell by clicking the button below.

   

3. Create your own Terraform Configurations

   While this is the more complex deployment path, there may be reasons why this path is necessary.

   For example, you may want to add DAOS servers and clients to your existing Terraform configurations.

   When creating your own Terraform configurations refer to the documentation for the modules:

   • daos_server module
   • daos_client module

   You can also use the terraform/examples/daos_cluster example as a reference.

   Note that DAOS servers and clients should be deployed in the same Terraform configuration. This is because there are variables in the daos_client module that must get their values from the daos_server module.

Support

Content in the google-cloud-daos repository is licensed under the Apache License Version 2.0 open-source license.

DAOS is being distributed under the BSD-2-Clause-Patent open-source license.

Intel Corporation provides several ways for the users to get technical support:

1. Community support is available to everybody through Jira and via the DAOS channel for the Google Cloud users on Slack.

   To access Jira, please follow these steps:

   • Navigate to https://daosio.atlassian.net/jira/software/c/projects/DAOS/issues/

   • You will need to request access to DAOS Jira to be able to create and update tickets. An Atlassian account is required for this type of access. Read-only access is available without an account.

   • If you do not have an Atlassian account, follow the steps at https://support.atlassian.com/atlassian-account/docs/create-an-atlassian-account/ to create one.

   To access the Slack channel for DAOS on Google Cloud, please follow this link https://daos-stack.slack.com/archives/C03GLTLHA59

   This type of support is provided on a best-effort basis, and it does not have any SLA attached.

2. Commercial L3 support is available on an on-demand basis. Please get in touch with Intel Corporation to obtain more information.

   • You may inquire about the L3 support via the Slack channel (https://daos-stack.slack.com/archives/C03GLTLHA59)

Links

• Distributed Asynchronous Object Storage (DAOS)
• Google Cloud Platform (GCP)
• Google Cloud HPC Toolkit
• Google Cloud CLI (gcloud)
• Google Cloud Build
• Cloud Shell
• Packer
• Terraform

Development

If you are contributing to this repo, see Development

License

Apache License Version 2.0