Skip to content
Snippets Groups Projects
Commit ee550274 authored by Yas Naoi's avatar Yas Naoi Committed by Yas Naoi
Browse files

Issue #3048701 by yas, baldwinlouie: Re-arrange README.md

parent b67eb6b4
No related branches found
No related tags found
No related merge requests found
......@@ -12,10 +12,10 @@ Requirements
- `MySQL 5.5` or higher _OR_
- `MariaDB 5.5` or higher
- `MariaDB 10.1` or higher
- `Drupal 8.6.3` or higher
- `Drupal 8.x` (Latest version of Drupal 8)
- `Cloud 8.x-1.x`
- This branch is still under development. Any volunteer effort is greatly
appreciated.
......@@ -24,9 +24,11 @@ Requirements
Limitations
===========
- The aws_cloud module does **not** support *Classic Ec2 instances* (`Non-VPC`).
- The aws_cloud module does **not** support *Classic Ec2 instances*
(`Non-VPC`).
**Note:** Classic instances (`Non-VPC`) are available for AWS accounts created before *2013-12-03*.
**Note:** Classic instances (`Non-VPC`) are available for AWS accounts
created before *2013-12-03*.
`aws_cloud` module is only tested for `EC2-VPC` instances.
See also:
......@@ -46,7 +48,7 @@ Installation (For usage with Amazon EC2)
2. Download `cloud` module.
3. Enable the `aws_cloud module`. This will also enable the required modules.
_OR_ (using `composer`)
_OR_ (using `composer`)
- `composer require drupal/cloud`
......@@ -58,19 +60,28 @@ Basic Setup
-----------
1. Create a new `Cloud Config` based on your needs. Go to `Structure` > `Cloud
config list` and `+ Add Cloud config`
2. Enter all required configuration parameters. The system will automatically setup all regions
from your AWS account. There are three options for specifying AWS credentials:
2. Enter all required configuration parameters. The system will automatically
setup all regions from your AWS account. There are three options for
specifying AWS credentials:
a. Instance credentials - If cloud module is running on an EC2 instance and the EC2 instance has an IAM Role
attached, you have the option to check "Use Instance Credentials". Doing so is secure
and does not require `access id` and `secret access key` to be entered into Drupal.
Please refer to this AWS tutorial about IAM role and EC2 Instance: https://aws.amazon.com/blogs/security/easily-replace-or-attach-an-iam-role-to-an-existing-ec2-instance-by-using-the-ec2-console/
a. Instance credentials - If cloud module is running on an EC2 instance and
the EC2 instance has an IAM Role attached, you have the option to check "Use
Instance Credentials". Doing so is secure and does not require `access id`
and `secret access key` to be entered into Drupal.
Please refer to this AWS tutorial about IAM role and EC2 Instance:
b. Simple access - Specify `access id` and `secret access key` to access a particular account's EC2 instances.
https://aws.amazon.com/blogs/security/easily-replace-or-attach-an-iam-role-to-an-existing-ec2-instance-by-using-the-ec2-console/
c. Assume role - Specify `access id`, `secret access key` and the `Assume Role` section. With this combination,
the cloud module can assume the role of another AWS account and access their EC2 instances. To learn more about
setting up assume role setup, please read this AWS tutorial: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_permissions-to-switch.html
b. Simple access - Specify `access id` and `secret access key` to access a
particular account's EC2 instances.
c. Assume role - Specify `access id`, `secret access key` and the
`Assume Role` section. With this combination, the cloud module can
assume the role of another AWS account and access their EC2 instances.
To learn more about setting up assume role setup, please read this AWS
tutorial:
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_permissions-to-switch.html
3. Run cron to update your specific Cloud region.
4. Use the links under `Cloud Service Providers` > `[CLOUD CONFIG]` to manage
......@@ -105,10 +116,10 @@ Directory Structure
===================
```
cloud (Cloud is a core module for Cloud package)
+-modules (depends on Cloud module)
+-cloud_server_templates
+-cloud_service_providers
- aws_cloud
└── modules
├── cloud_server_template (Merged into cloud module, removed in the future)
└── cloud_service_providers
└── aws_cloud
```
Maintainers
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment