From 8ed994628e9702f5181a1003d04feb3aa7dc723a Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 10:39:56 -0400 Subject: [PATCH 1/8] Edits for LAMP about page --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 34fc56a..f37b95e 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,46 @@ -# LAMP Template +# LAMP template -An IBM Cloud Schematics template to provision a virtual machine instance and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure as code engine. With this template, you can provision and manage infrastructure as a single unit. +The LAMP template is an IBM Cloud Schematics template used to create a virtual machine instance and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. -See the IBM Cloud docs for more information about [Schematics](https://cloud.ibm.com/docs/schematics). +For more information, go to the documentation for [IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics). ## Costs -This sample uses chargable services and **will** incur costs for the time the services are deployed. Execution of `terraform destroy` will result in deletion of all resources including the ICD service instance. Billing for VSIs and ICD will terminate on the hour. +This sample uses chargable services and you are charged for the time the services are deployed. The use of `terraform destroy` results in deletion of all resources including the IBM Cloud database service instance. Billing for virtual server instances (VSIs) and IBM Cloud database terminates on the hour. ## Dependencies -- User has IAM security rights to create and configure an IBM Cloud Database instance and VSIs +The user must have IAM access to create and configure an IBM Cloud database instance and VSIs. -## Identity & Access Management (IAM) Permissions +## Identity & Access Management (IAM) access -The following variables need to be set before use +The following variables need to be set before using the template: -* `softlayer_username` is an Infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select the user, scroll down and check username under VPN password. -* `softlayer_api_key` is an Infrastructure API Key. Go to https://cloud.ibm.com/iam/users/, select the user, scroll down and check Classic infrastructure API key under API keys. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create a new Classic infrastructure key. +* `softlayer_username` is a the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify the user name is listed in the VPN password section. +* `softlayer_api_key` is a classic infrastructure API key. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that a classic infrastructure API key is already created in the API keys section. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create one. -### Variables +## Variables |Variable Name|Description|Default Value| |-------------|-----------|-------------| |cores|The number of CPU cores to allocate.|1| -|datacenter|The data center to create resources in. You can get the list by running `ibmcloud cs locations`.|wdc01| -|disk_size|The numeric disk sizes (in GB) for the instance’s block device and disk image settings.|25| -|domain|The domain for the instance.|domain.dev| -|hostname|The hostname for the instance.|lamp| -|memory|The amount of memory, expressed in megabytes, to allocate.|1026| -|network_speed|The connection speed (in Mbps) for the instance’s network components.|100| -|os_reference_code|The operating system reference code that is used to provision the computing instance. To see available OS reference codes, log in to the [IBM Cloud Infrastructure (SoftLayer) API](https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.json?objectMask=referenceCode).|CENTOS_LATEST_64| -|private_network_only|When set to true, a compute instance only has access to the private network.|false| -|softlayer_api_key|Your IBM Cloud Infrastructure (SoftLayer) API key.|| -|softlayer_username|Your IBM Cloud Infrastructure (SoftLayer) user name.|| -|ssh_key|Your public SSH key to access the VM.|| +|datacenter|The data center to create resources in, for example dal13. To get a list of all data centers, run the `ic sl vs options` command.|wdc01| +|disk_size|The numeric disk sizes in GB for the instance’s block device and disk image settings.|25| +|domain|The domain for the instance. For example: domain.dev|domain.dev| +|hostname|The hostname for the instance. For example: vm1|lamp| +|memory|The amount of memory in MB to allocate.|1026| +|network_speed|The connection speed in Mbps for the instance’s network components.|100| +|os_reference_code|The code that is used to provision the computing instance. To see available OS reference codes, log in to the [IBM Cloud Infrastructure (SoftLayer) API](https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.json?objectMask=referenceCode).|CENTOS_LATEST_64| +|private_network_only|Enter true or false. True means a compute instance has access only to the private network.|false| +|softlayer_api_key|Enter your classic infrastructure API key. Go to https://cloud.ibm.com/iam/apikeys to get the details of an existing API key or create a new one.|| +|softlayer_username|Enter your classic infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, and get your user name from the VPN password section. || +|ssh_key|Your public SSH key to access the virtual machine. Your public key is saved to a file called id_rsa.pub in the .ssh subdirectory of your home directory.|| |ssh_label|An identifying label to assign to the SSH key.|public ssh key - Schematics VM| |ssh_notes|A description to assign to the SSH key.|| -|ssh_user|The provisioning username.|root| -|tags|Descriptive tags to label the resource.|| +|ssh_user|The default user name for the virtual machine. For example, the "root" user for UNIX operating systems |root| +|tags|Add descriptive tags to label the resource.  A tag is a label that you assign to a resource for easy filtering of resources in your resource list.|| ## Outputs -This template outputs the IPv4 address of the created virtual machine +This template outputs the IPv4 address of the created virtual machine. From ac6aba36ff2f41f988f8f365182ff1d350b3602c Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 10:55:06 -0400 Subject: [PATCH 2/8] update --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f37b95e..46ba953 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,20 @@ This sample uses chargable services and you are charged for the time the service ## Dependencies -The user must have IAM access to create and configure an IBM Cloud database instance and VSIs. +The user must have Identity and Access Management (IAM) access to create and configure an IBM Cloud database instance and VSIs. -## Identity & Access Management (IAM) access +### IAM access The following variables need to be set before using the template: * `softlayer_username` is a the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify the user name is listed in the VPN password section. * `softlayer_api_key` is a classic infrastructure API key. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that a classic infrastructure API key is already created in the API keys section. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create one. -## Variables +### Deployment values -|Variable Name|Description|Default Value| +The following deployment values must be set. You can enter customized values or accept the default values. + +|Value Name|Description|Default Value| |-------------|-----------|-------------| |cores|The number of CPU cores to allocate.|1| |datacenter|The data center to create resources in, for example dal13. To get a list of all data centers, run the `ic sl vs options` command.|wdc01| From 97b25915f6114bee178c5c3871cdac58b9cc497b Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 10:59:41 -0400 Subject: [PATCH 3/8] another edit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 46ba953..6d4a037 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This sample uses chargable services and you are charged for the time the service The user must have Identity and Access Management (IAM) access to create and configure an IBM Cloud database instance and VSIs. -### IAM access +## Configuring your deployment values The following variables need to be set before using the template: From b11fb47e43f971b27202b279fd1409859df50cb0 Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 11:01:45 -0400 Subject: [PATCH 4/8] more edit --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6d4a037..b5b5814 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,12 @@ The user must have Identity and Access Management (IAM) access to create and con ## Configuring your deployment values -The following variables need to be set before using the template: +The following variables need to be set before you can use the template: * `softlayer_username` is a the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify the user name is listed in the VPN password section. * `softlayer_api_key` is a classic infrastructure API key. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that a classic infrastructure API key is already created in the API keys section. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create one. -### Deployment values - -The following deployment values must be set. You can enter customized values or accept the default values. +You must also set the following deployment values on the Create page. You can enter customized values or accept the defaults. |Value Name|Description|Default Value| |-------------|-----------|-------------| From f7444f329133a35a79dc256dafb62de77cad6991 Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 11:18:48 -0400 Subject: [PATCH 5/8] sp check --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b5b5814..8d73435 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # LAMP template -The LAMP template is an IBM Cloud Schematics template used to create a virtual machine instance and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. +The LAMP template is an IBM Cloud Schematics template that is used to create a virtual machine instance and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. For more information, go to the documentation for [IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics). ## Costs -This sample uses chargable services and you are charged for the time the services are deployed. The use of `terraform destroy` results in deletion of all resources including the IBM Cloud database service instance. Billing for virtual server instances (VSIs) and IBM Cloud database terminates on the hour. +This sample uses chargeable services and you are charged for the time the services are deployed. The use of `terraform destroy` results in deletion of all resources including the IBM Cloud database service instance. Billing for virtual server instances (VSIs) and IBM Cloud database terminates on the hour. ## Dependencies @@ -16,7 +16,7 @@ The user must have Identity and Access Management (IAM) access to create and con The following variables need to be set before you can use the template: -* `softlayer_username` is a the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify the user name is listed in the VPN password section. +* `softlayer_username` is the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that the user name is listed in the VPN password section. * `softlayer_api_key` is a classic infrastructure API key. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that a classic infrastructure API key is already created in the API keys section. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create one. You must also set the following deployment values on the Create page. You can enter customized values or accept the defaults. From 554cc468d24d4bdce56cb5d8973973840e696482 Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 11:35:37 -0400 Subject: [PATCH 6/8] table header --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d73435..761f7cf 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The following variables need to be set before you can use the template: You must also set the following deployment values on the Create page. You can enter customized values or accept the defaults. -|Value Name|Description|Default Value| +|Variable Name|Description|Default Value| |-------------|-----------|-------------| |cores|The number of CPU cores to allocate.|1| |datacenter|The data center to create resources in, for example dal13. To get a list of all data centers, run the `ic sl vs options` command.|wdc01| From ebb49a132ca337a9d842fad0b01efe38dd9e24e9 Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 12:41:11 -0400 Subject: [PATCH 7/8] Edits from Courtney --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 761f7cf..94930df 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # LAMP template -The LAMP template is an IBM Cloud Schematics template that is used to create a virtual machine instance and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. +The LAMP template is an IBM Cloud Schematics template that is used to create a virtual server instance (VSI) and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. -For more information, go to the documentation for [IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics). +For more information about how to use the template, go to the documentation for [IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics). ## Costs -This sample uses chargeable services and you are charged for the time the services are deployed. The use of `terraform destroy` results in deletion of all resources including the IBM Cloud database service instance. Billing for virtual server instances (VSIs) and IBM Cloud database terminates on the hour. +This sample uses chargeable services and you are charged for the time the services are deployed. Running the `terraform destroy` command deletes all resources, including the IBM Cloud database service instance. Billing for virtual server instances (VSIs) and IBM Cloud database terminates on the hour. ## Dependencies @@ -16,30 +16,29 @@ The user must have Identity and Access Management (IAM) access to create and con The following variables need to be set before you can use the template: -* `softlayer_username` is the infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that the user name is listed in the VPN password section. -* `softlayer_api_key` is a classic infrastructure API key. Go to https://cloud.ibm.com/iam/users/, select your name, then verify that a classic infrastructure API key is already created in the API keys section. If you don't have one already, go to https://cloud.ibm.com/iam/#/apikeys and create one. +* `softlayer_username` is a the infrastructure user name. Go to **Access (IAM) > Users**, and select your name. Then, verify the user name is listed in the VPN password section. +* `softlayer_api_key` is a classic infrastructure API key. Go to **Access (IAM) > Users**, and select your name. Then, verify that a classic infrastructure API key is included in the API keys section. If you don't have one already, you can create one from theh [IBM Cloud API keys page](https://cloud.ibm.com/iam/apikeys). You must also set the following deployment values on the Create page. You can enter customized values or accept the defaults. |Variable Name|Description|Default Value| |-------------|-----------|-------------| |cores|The number of CPU cores to allocate.|1| -|datacenter|The data center to create resources in, for example dal13. To get a list of all data centers, run the `ic sl vs options` command.|wdc01| +|datacenter|The data center to create resources in, for example, dal13. To get a list of all data centers, run the `ic sl vs options` command.|wdc01| |disk_size|The numeric disk sizes in GB for the instance’s block device and disk image settings.|25| -|domain|The domain for the instance. For example: domain.dev|domain.dev| -|hostname|The hostname for the instance. For example: vm1|lamp| +|domain|The domain for the instance, for example, domain.dev|domain.dev| +|hostname|The hostname for the instance, for example, vm1|lamp| |memory|The amount of memory in MB to allocate.|1026| |network_speed|The connection speed in Mbps for the instance’s network components.|100| |os_reference_code|The code that is used to provision the computing instance. To see available OS reference codes, log in to the [IBM Cloud Infrastructure (SoftLayer) API](https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getVhdImportSoftwareDescriptions.json?objectMask=referenceCode).|CENTOS_LATEST_64| |private_network_only|Enter true or false. True means a compute instance has access only to the private network.|false| -|softlayer_api_key|Enter your classic infrastructure API key. Go to https://cloud.ibm.com/iam/apikeys to get the details of an existing API key or create a new one.|| -|softlayer_username|Enter your classic infrastructure user name. Go to https://cloud.ibm.com/iam/users/, select your name, and get your user name from the VPN password section. || -|ssh_key|Your public SSH key to access the virtual machine. Your public key is saved to a file called id_rsa.pub in the .ssh subdirectory of your home directory.|| +|softlayer_api_key|Enter your classic infrastructure API key. See the [IBM Cloud API keys page](https://cloud.ibm.com/iam/apikeys) to get the details of an existing API key or to create a new one.|| +|softlayer_username|Enter your classic infrastructure user name. Go to **Access (IAM) > Users**, and select your name. Then, locate your user name from the VPN password section. || +|ssh_key|Your public SSH key to access the virtual machine. Your public key is saved to a `id_rsa.pub` file in the `.ssh` subdirectory of your home directory.|| |ssh_label|An identifying label to assign to the SSH key.|public ssh key - Schematics VM| |ssh_notes|A description to assign to the SSH key.|| -|ssh_user|The default user name for the virtual machine. For example, the "root" user for UNIX operating systems |root| -|tags|Add descriptive tags to label the resource.  A tag is a label that you assign to a resource for easy filtering of resources in your resource list.|| - +|ssh_user|The default user name for the virtual machine, for example, the "root" user for UNIX operating systems. |root| +|tags|Add descriptive tags to label the resource. A tag is a label that you assign to a resource for easy filtering of resources in your resource list.|| ## Outputs This template outputs the IPv4 address of the created virtual machine. From b52d5e998cd58d7be00b906e344a84855553b8d5 Mon Sep 17 00:00:00 2001 From: mekaufman Date: Tue, 17 Sep 2019 14:08:30 -0400 Subject: [PATCH 8/8] final edits --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 94930df..50c1624 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The LAMP template is an IBM Cloud Schematics template that is used to create a virtual server instance (VSI) and configure it with the "LAMP" stack: Linux, Apache, MySQL (mariadb), and PHP. Schematics uses [Terraform](https://www.terraform.io/) as the infrastructure-as-code engine. With this template, you can create and manage infrastructure as a single unit. -For more information about how to use the template, go to the documentation for [IBM Cloud Schematics](https://cloud.ibm.com/docs/schematics). +For more information about how to use the template, see the [IBM Cloud Schematics documentation](https://cloud.ibm.com/docs/schematics). ## Costs @@ -14,10 +14,10 @@ The user must have Identity and Access Management (IAM) access to create and con ## Configuring your deployment values -The following variables need to be set before you can use the template: +Set the following variables before you use the template: * `softlayer_username` is a the infrastructure user name. Go to **Access (IAM) > Users**, and select your name. Then, verify the user name is listed in the VPN password section. -* `softlayer_api_key` is a classic infrastructure API key. Go to **Access (IAM) > Users**, and select your name. Then, verify that a classic infrastructure API key is included in the API keys section. If you don't have one already, you can create one from theh [IBM Cloud API keys page](https://cloud.ibm.com/iam/apikeys). +* `softlayer_api_key` is a classic infrastructure API key. Go to **Access (IAM) > Users**, and select your name. Then, verify that a classic infrastructure API key is included in the API keys section. If you don't have one already, you can create one from the [IBM Cloud API keys page](https://cloud.ibm.com/iam/apikeys). You must also set the following deployment values on the Create page. You can enter customized values or accept the defaults. @@ -38,7 +38,7 @@ You must also set the following deployment values on the Create page. You can en |ssh_label|An identifying label to assign to the SSH key.|public ssh key - Schematics VM| |ssh_notes|A description to assign to the SSH key.|| |ssh_user|The default user name for the virtual machine, for example, the "root" user for UNIX operating systems. |root| -|tags|Add descriptive tags to label the resource. A tag is a label that you assign to a resource for easy filtering of resources in your resource list.|| +|tags|Add descriptive tags to label the resource. A tag is a label that you assign to a resource for easy filtering of resources in your resource list.|| ## Outputs This template outputs the IPv4 address of the created virtual machine.