You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1.**Set defaults for Google Cloud CLI (```gcloud```)**
52
54
53
55
Only needs to be done once in your shell (Cloud Shell or local shell).
54
56
55
-
2.**Create a Packer image in your GCP project**
57
+
2.**Enable service APIs and grant permissions**
58
+
59
+
Enabling APIs and granting service account permissions only needs to be done once for a GCP project.
60
+
61
+
3.**Create a Packer image in your GCP project**
56
62
57
63
In order to build DAOS images with Cloud Build your GCP project must contain a Packer image.
58
64
59
-
Building the Packer images only needs to be done once for a GCP project.
65
+
Building the Packer image only needs to be done once for a GCP project.
60
66
61
-
3.**Build DAOS Server and Client images**
67
+
4.**Build DAOS Server and Client images**
62
68
63
69
DAOS Server and Client instances are deployed using images that have DAOS pre-installed.
64
70
65
-
Therefore, the images need to be built prior to running Terraform.
71
+
Therefore, the images need to be built prior to running Terraform to deploy a DAOS cluster.
72
+
73
+
Click the button below to open a Cloud Shell tutorial which will guide you through the pre-deployment steps listed above. If you lose your Cloud Shell session you can always come back to this README and click the button again.
74
+
75
+
[](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/daos-stack/google-cloud-daos&cloudshell_git_branch=main&shellonly=true&tutorial=docs/tutorials/pre-deployment.md)
76
+
77
+
### Deploy a DAOS Cluster with Terraform
78
+
79
+
After completing the pre-deployment steps listed above, you will need to write your own Terraform configuration for your particular use case.
80
+
81
+
The [terraform/modules](terraform/modules) in this repo can be used in your Terraform configuration to deploy DAOS server and client instances.
82
+
83
+
The [terraform/examples/daos_cluster](terraform/examples/daos_cluster/README.md) example serves as both a reference and a quick way to deploy a DAOS cluster.
84
+
85
+
Click the button below to open a Cloud Shell tutorial that will walk you through using the [terraform/examples/daos_cluster](terraform/examples/daos_cluster/README.md) example to deploy a DAOS cluster.
### Deploy a DAOS Cluster with the Google HPC Toolkit
66
90
67
-
> Click the button to open an interactive walk-through in Cloud Shell which will guide you through the steps listed above.
68
-
>
69
-
> [](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/daos-stack/google-cloud-daos&cloudshell_git_branch=main&shellonly=true&tutorial=docs/tutorials/daosgcp_setup.md)
91
+
The [HPC Toolkit](https://github.com/GoogleCloudPlatform/hpc-toolkit) is an open-source software offered by Google Cloud which makes it easy for customers to deploy HPC environments on Google Cloud.
70
92
71
-
4.**Use DAOS Terraform modules in your Terraform code**
93
+
The HPC Toolkit allows customers to deploy turnkey HPC environments (compute, networking, storage, etc) following Google Cloud best-practices, in a repeatable manner. It is designed to be highly customizable and extensible, and intends to address the HPC deployment needs of a broad range of customers.
72
94
73
-
You will need to write your own Terraform code for your particular use case.
95
+
The HPC Toolkit includes the following community examples which use the Terraform modules in this repository.
74
96
75
-
Your Terraform code can use the modules in ```terraform/modules``` to deploy DAOS server and client instances.
97
+
| HPC Toolkit Community Example | Description |
98
+
| ----------------------------- | ----------- |
99
+
|[DAOS Cluster](https://github.com/GoogleCloudPlatform/hpc-toolkit/tree/main/community/examples/intel#daos-cluster)| Use the HPC Toolkit to deploy a standalone DAOS cluster |
100
+
|[DAOS Server with Slurm cluster](https://github.com/GoogleCloudPlatform/hpc-toolkit/tree/main/community/examples/intel#daos-server-with-slurm-cluster)| Use the HPC Toolkit to deploy a set of DAOS servers for storage and a Slurm cluster in which the compute nodes are DAOS clients. The example demonstrates how to use DAOS storage in a Slurm job. |
76
101
77
-
The example Terraform configurations provided in ```terraform/examples``` can be used as a reference.
102
+
If you are just getting started with deploying DAOS on GCP, it is highly recommended to use the HPC Toolkit as it can save you a lot of time as opposed to developing your own Terraform configuration.
78
103
79
-
See the [DAOS Cluster](terraform/examples/daos_cluster/README.md) example to learn more about how to use the ```terraform/modules```.
104
+
## Support
105
+
106
+
Content in the [google-cloud-daos](https://github.com/daos-stack/google-cloud-daos) repository is licensed under the [Apache License Version 2.0](LICENSE) open-source license.
107
+
108
+
[DAOS](https://github.com/daos-stack/daos) is being distributed under the BSD-2-Clause-Patent open-source license.
109
+
110
+
Intel Corporation provides several ways for the users to get technical support:
111
+
112
+
1. Community support is available to everybody through Jira and via the DAOS channel for the Google Cloud users on Slack.
113
+
114
+
To access Jira, please follow these steps:
115
+
116
+
- Navigate to https://daosio.atlassian.net/jira/software/c/projects/DAOS/issues/
117
+
118
+
- 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.
119
+
- 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.
120
+
121
+
To access the Slack channel for DAOS on Google Cloud, please follow this link https://daos-stack.slack.com/archives/C03GLTLHA59
122
+
123
+
> This type of support is provided on a best-effort basis, and it does not have any SLA attached.
124
+
125
+
2. Commercial L3 support is available on an on-demand basis. Please get in touch with Intel Corporation to obtain more information.
126
+
127
+
- You may inquire about the L3 support via the Slack channel (https://daos-stack.slack.com/archives/C03GLTLHA59)
See the [installation instructions](https://github.com/terraform-linters/tflint#installation)
@@ -31,8 +30,23 @@ You will also need to install the dependencies that are required for the pre-com
31
30
32
31
See [https://github.com/terraform-docs/terraform-docs](https://github.com/terraform-docs/terraform-docs)
33
32
33
+
4. Add `ADDLICENSE_COMPANY_NAME` environment variable to your `~/.bashrc` file
34
+
35
+
When pre-commit runs for the first time it will download the [google/addlicense](https://github.com/google/addlicense/releases/tag/v1.0.0) binary into the `tools/autodoc/` directory. The `addlicense` binary is excluded in the `.gitignore` file so it does not get checked into the repo.
36
+
37
+
The `addlicense` pre-commit hook will ensure that files have the proper license header.
38
+
39
+
The company name that is used in the license header is specified in the `ADDLICENSE_COMPANY_NAME` environment variable.
40
+
41
+
If the `ADDLICENSE_COMPANY_NAME` environment variable is not present, the company name in the license header will be set to **Intel Corporation**
42
+
43
+
If you do not work for Intel be sure to export the `ADDLICENSE_COMPANY_NAME` environment variable with the name of your company as it should appear in the license header of files.
0 commit comments