|
|
Line 69: |
Line 69: |
| {| | | {| |
| |style="padding: 0px 0px 0px 45px;"|✔ Toggle API Request Logging | | |style="padding: 0px 0px 0px 45px;"|✔ Toggle API Request Logging |
| + | |} |
| + | {| |
| + | |style="padding: 0px 0px 0px 45px;"|✔ Shut Down VM Before Upgrade |
| |} | | |} |
| {| | | {| |
Line 87: |
Line 90: |
| {| | | {| |
| |style="padding: 0px 0px 0px 45px;"|✔ Set Volume IOPS | | |style="padding: 0px 0px 0px 45px;"|✔ Set Volume IOPS |
| + | |} |
| + | {| |
| + | |style="padding: 0px 0px 0px 45px;"|✔ Set Email Template After Server Creation |
| + | |} |
| + | {| |
| + | |style="padding: 0px 0px 0px 45px;"|✔ Select Bandwidth Metrics Period |
| |} | | |} |
| {| | | {| |
Line 179: |
Line 188: |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.4 | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.8 Back To WHMCS V8.6 |
| |} | | |} |
| {| | | {| |
Line 340: |
Line 349: |
| | | |
| * '''Number of Firewall Rules''' - Fill in a number of '' 'Firewall Rules' '' that can be set up by a client. | | * '''Number of Firewall Rules''' - Fill in a number of '' 'Firewall Rules' '' that can be set up by a client. |
− |
| |
− | * '''Tag Name''' - Define a tag name, this label will be assigned to EC2 resources
| |
| | | |
| * '''Number of IPv4 Addresses''' - Enter a maximum number of allowed, public IP addresses (Elastic IP) - once assigned, are not removed when stopping the machine.<br/> If entered "0" value, EC2 will assign a random IP address from one of the default EC2 subnets - such IP is deleted after stopping the machine. | | * '''Number of IPv4 Addresses''' - Enter a maximum number of allowed, public IP addresses (Elastic IP) - once assigned, are not removed when stopping the machine.<br/> If entered "0" value, EC2 will assign a random IP address from one of the default EC2 subnets - such IP is deleted after stopping the machine. |
| + | |
| + | * '''Tag Name''' - Define a tag name, this label will be assigned to EC2 resources |
| | | |
| * '''User Data''' - You can specify user data to configure an instance or run a configuration script during launch. This field is optional.<br/> Tutorial on how to use this option can be found [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html here]. | | * '''User Data''' - You can specify user data to configure an instance or run a configuration script during launch. This field is optional.<br/> Tutorial on how to use this option can be found [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html here]. |
Line 350: |
Line 359: |
| | | |
| * '''Subnet''' - A subnet to which an instance will be launched. | | * '''Subnet''' - A subnet to which an instance will be launched. |
| + | |
| + | * '''Volume Size''' - Volume size has to be greater than 0. If you do not specify the volume size, the default is the snapshot size. Provisioned IOPS volumes must be at least 100GB in size. |
| + | |
| + | * '''Volume Type''' - General Purpose (SSD) volumes can burst to 3000 IOPS, and deliver a consistent baseline of 3 IOPS/GiB. Provisioned IOPS (SSD) volumes can deliver up to 64000 IOPS and are best for EBS-optimized instances.<br/> Magnetic volumes (previously called standard volumes) can deliver 100 IOPS on average and burst to hundreds of IOPS.<br/> If you want to learn more about volume types, please refer to [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html this website]. |
| + | |
| + | * '''Volume IOPS''' - is the requested number of I/O operations per second that the volume can support. For Provisioned IOPS (SSD) volumes, you can provision up to 50 IOPS per GiB. <br/>For General Purpose (SSD) volumes, baseline performance is 3 IOPS per GiB, with a minimum of 100 IOPS and maximum of 16000 IOPS. General Purpose (SSD) volumes under 1000 GiB can burst up to 3000 IOPS. |
| | | |
| * ''' Capacity Reservation''' - Capacity Reservations reserve capacity for your EC2 instances in a specific Availability Zone.<br/> You can launch instances into a Capacity Reservation if they have matching attributes (instance type, platform, and Availability Zone), and available capacity | | * ''' Capacity Reservation''' - Capacity Reservations reserve capacity for your EC2 instances in a specific Availability Zone.<br/> You can launch instances into a Capacity Reservation if they have matching attributes (instance type, platform, and Availability Zone), and available capacity |
Line 357: |
Line 372: |
| * '''Log API Requests''' - Enable to allow storing information on API requests in the '' 'Module Log' '' section in your WHMCS. | | * '''Log API Requests''' - Enable to allow storing information on API requests in the '' 'Module Log' '' section in your WHMCS. |
| | | |
− | * '''Volume Size''' - Volume size has to be greater than 0. If you do not specify the volume size, the default is the snapshot size. Provisioned IOPS volumes must be at least 100GB in size. | + | * '''Shut Down VM Before Upgrade''' - Automatically shut down a VM before upgrading it, to prevent potential crashes and errors during the upgrade process |
| | | |
− | * '''Volume Type''' - General Purpose (SSD) volumes can burst to 3000 IOPS, and deliver a consistent baseline of 3 IOPS/GiB. Provisioned IOPS (SSD) volumes can deliver up to 64000 IOPS and are best for EBS-optimized instances.<br/> Magnetic volumes (previously called standard volumes) can deliver 100 IOPS on average and burst to hundreds of IOPS.<br/> If you want to learn more about volume types, please refer to [https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html this website]. | + | * '''Email Template''' - Choose an email template that will be sent to a client when the VM is created. Please refer to [[#Tips|Tips]] section tip 3 to read more about allowed parameters. |
| | | |
− | * '''Volume IOPS''' - is the requested number of I/O operations per second that the volume can support. For Provisioned IOPS (SSD) volumes, you can provision up to 50 IOPS per GiB. <br/>For General Purpose (SSD) volumes, baseline performance is 3 IOPS per GiB, with a minimum of 100 IOPS and maximum of 16000 IOPS. General Purpose (SSD) volumes under 1000 GiB can burst up to 3000 IOPS. | + | * '''Bandwidth Metrics Period''' - Specify bandwidth metrics period by choosing between: |
| + | ** 'Current month' |
| + | ** 'Last month' |
| + | ** 'Based on billing cycle options' <br/ > '''''Note:''' It is advised to set the product billing type to 'Recurring', in case you choose 'One Time', the module will calculate only the past 30 days for bandwidth usage.'' |
| | | |
− | * '''Email Template''' - choose an email template that will be sent to a client when the VM is created. Please refer to [[#Tips|Tips]] section tip 3 to read more about allowed parameters.
| + | Client Area Configuration: |
| | | |
| * '''Show Windows Password''' - this option works only for Windows instances. After the launch of the instance, password generation and encryption may take up to 15 minutes. | | * '''Show Windows Password''' - this option works only for Windows instances. After the launch of the instance, password generation and encryption may take up to 15 minutes. |
Line 382: |
Line 400: |
| Here, you may look for and then select single images to be added to the list. They will be available to choose from in the Amazon Machine Images (AMI) field in the main configuration of the product.<br/> | | Here, you may look for and then select single images to be added to the list. They will be available to choose from in the Amazon Machine Images (AMI) field in the main configuration of the product.<br/> |
| | | |
− | First of all, enter as many details as possible to find the images you are interested in. Press search button when ready. | + | First of all, enter as many details as possible to find the images you are interested in. Press the search button when ready. |
| |} | | |} |
| {| | | {| |
Line 472: |
Line 490: |
| This includes supervision of such features as: | | This includes supervision of such features as: |
| # Configurable options which enable you to view the chosen server details | | # Configurable options which enable you to view the chosen server details |
− | # Module commands to allow easy and quick management of the server<br/> '''''Important:''' In order to successfully complete the change package action, the machine must be previously stopped by your client.'' | + | # Module commands to allow easy and quick management of the server<br/> '''''Important:''' In order to successfully complete the change package action, the machine must be previously stopped by your client (see the [[#Configuration_of_Product|product configuration]] to enable automation).'' <br/> '''''Note:''' When changing the package, a custom security group will be added to the firewall if none has been yet created.'' |
| # Service actions, including: ''Start'', ''Stop'' and ''Reboot'' the server | | # Service actions, including: ''Start'', ''Stop'' and ''Reboot'' the server |
| # Instance details that provide the current status, resources and options set. | | # Instance details that provide the current status, resources and options set. |
3. Amazon EC2 module supports all the default WHMCS marge field variables, they can be freely used in the welcome email template. Read more about module parameters here.
The module also supports the below listed AWS variables:
'AmiLaunchIndex', 'ImageId', 'InstanceId', 'InstanceType', 'KeyName', 'Monitoring_State', 'Placement_AvailabilityZone', 'Placement_GroupName', 'Placement_Tenancy', 'PrivateDnsName', 'PrivateIpAddress', 'ProductCodes',
'PublicDnsName', 'State_Code', 'State_Name', 'StateTransitionReason', 'SubnetId', 'VpcId', 'Architecture', 'BlockDeviceMappings', 'ClientToken', 'EbsOptimized', 'EnaSupport', 'Hypervisor',
'NetworkInterfaces_0_Attachment_AttachmentId', 'NetworkInterfaces_0_Attachment_DeleteOnTermination', 'NetworkInterfaces_0_Attachment_DeviceIndex', 'NetworkInterfaces_0_Attachment_Status', 'NetworkInterfaces_0_Description',
'NetworkInterfaces_0_Groups_0_GroupName', 'NetworkInterfaces_0_Groups_0_GroupId', 'NetworkInterfaces_0_Ipv6Addresses', 'NetworkInterfaces_0_MacAddress', 'NetworkInterfaces_0_NetworkInterfaceId', 'NetworkInterfaces_0_OwnerId',
'NetworkInterfaces_0_PrivateDnsName', 'NetworkInterfaces_0_PrivateIpAddress', 'NetworkInterfaces_0_PrivateIpAddresses_0_Primary', 'NetworkInterfaces_0_PrivateIpAddresses_0_PrivateDnsName',
'NetworkInterfaces_0_PrivateIpAddresses_0_PrivateIpAddress', 'NetworkInterfaces_0_SourceDestCheck', 'NetworkInterfaces_0_Status', 'NetworkInterfaces_0_SubnetId', 'NetworkInterfaces_0_VpcId', 'NetworkInterfaces_0_InterfaceType',
'RootDeviceName', 'RootDeviceType', 'SecurityGroups_0_GroupName', 'SecurityGroups_0_GroupId', 'SourceDestCheck', 'StateReason_Code', 'StateReason_Message', 'Tags_0_Key', 'Tags_0_Value', 'Tags_1_Key', 'Tags_1_Value',
'VirtualizationType', 'CpuOptions_CoreCount', 'CpuOptions_ThreadsPerCore', 'CapacityReservationSpecification_CapacityReservationPreference', 'HibernationOptions_Configured', 'MetadataOptions_State', 'MetadataOptions_HttpTokens',
'MetadataOptions_HttpPutResponseHopLimit', 'MetadataOptions_HttpEndpoint'
|