Global Site

Displaying present location in the site.

Introducing the Features of EXPRESSCLUSTER: Set Command Line Options and Environment Variables for AWS CLI of Cluster WebUI

EXPRESSCLUSTER Official Blog

December 2nd, 2024

Machine translation is used partially for this article. See the Japanese version for the original article.

Introduction

In EXPRESSCLUSTER X 5.1, we have enhanced many functions such as expanded functionality for the cloud, making it easier to build and operate, security enhancements, and support for new OS and platforms. As one of these enhancements, AWS-related features have also been enhanced of the Cluster WebUI.

This article introduces the AWS-related features enhancements of the Cluster WebUI. For other enhancements of EXPRESSCLUSTER X 5.1, please refer to popupEXPRESSCLUSTER X 5.1 New Enhancement document.

Contents

The AWS-related features of EXPRESSCLUSTER internally execute the AWS CLI, and until EXPRESSCLUSTER X 5.0, it was necessary to edit the environment variable configuration file in certain cases, such as the following:

  • Going through a proxy server when connecting to the Internet.
  • Performing detailed tuning of the operation of the AWS CLI.
  • Modifying settings to accommodate environment or system requirements.
The AWS-related features enhancements added in EXPRESSCLUSTER X 5.1 allow you to set the command line and environment variables for the AWS CLI from the Cluster WebUI for the above cases. Both of these settings can be configured in the "Cloud" tab of the "Cluster properties" in the Cluster WebUI. The following items have been added to the "Cloud" tab.

  • [Command line options]
    ー[AWS CLI Command line options]
  • [Environment variable]
    ー[Environment variables at the time of performing AWS-related features]

Cluster propertieszoomLarger view

For more "Cluster properties" information, please refer to the following:

popupDocumentation - Manuals
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Windows > Reference Guide
  • -> 2. Parameter details
  • -> 2.2. Cluster properties
  • -> 2.2.17. Cloud tab
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Linux > Reference Guide
  • -> 2. Parameter details
  • -> 2.2. Cluster properties
  • -> 2.2.19. Cloud tab

1.1 AWS CLI Command Line Options

You can set individual command line options for the AWS CLI, which is execute internally by AWS-related features. Use this when you want to set parameters for a specific the AWS CLI command.

As an example, consider a case where, due to network reasons, communication timeout errors occur intermittently to an endpoint when executing the AWS CLI (aws ec2) command. In this case, specifying the --cli-connect-timeout or --cli-read-timeout option of the AWS CLI to extend the timeout period can be expected to improve the situation.

The steps to set "--cli-connect-timeout 120" as a command line option for the AWS CLI (aws ec2) in the Cluster WebUI are as follows.

  • 1.
    Open "Cluster properties" from the configuration mode of the Cluster WebUI.
  • 2.
    Click the "Cloud" tab.
  • 3.
    Click the "Settings" button for "AWS CLI Command line options" under "Command line options".
  • 4.
    Enter "--cli-connect-timeout 120" in the [aws ec2].

AWS CLI Command Line OptionszoomLarger view

The relationship between the AWS service names displayed in the "AWS CLI Command line options" and AWS-related features is as follows:

■ aws cloudwatch
・Amazon CloudWatch linkage

■ aws ec2
・AWS Elastic IP resource
・AWS Virtual IP resource
・AWS Secondary IP resource
・AWS Elastic IP monitor resource
・AWS Virtual IP monitor resource
・AWS Secondary IP monitor resource
・AWS AZ monitor resource
・AWS Forced stop resource
・Obtaining cloud environment information with Cluster WebUI

■ aws route53
・AWS DNS resource
・AWS DNS monitor resource

■ aws sns
・Amazon SNS linkage

For more setting "AWS CLI Command line options" information, please refer to the following:

[Reference]
popupDocumentation - Manuals
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Windows > Getting Started Guide
  • -> 6. Notes and Restrictions
  • -> 6.3. Notes when creating the cluster configuration data
  • -> 6.3.11. AWS CLI command line options
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Linux > Getting Started Guide
  • -> 6. Notes and Restrictions
  • -> 6.4. Notes when creating EXPRESSCLUSTER configuration data
  • -> 6.4.20. AWS CLI command line options

1.2 Environment Variables at the Time of Performing AWS-Related Features

You can set environment variables for the AWS CLI when AWS-related features execute AWS CLI internally. Unlike command line option settings, these settings are common to all AWS-related features.

As an example, consider the case where a proxy server is specified with an environment variable. Normally, NAT is used when connecting to the Internet with EC2 instances for the HA cluster is placed on the private network, but depending on the environment, you may want to use a proxy server instead of NAT. In this case, set the environment variables for AWS CLI to communication goes through the proxy server. The steps to set the environment variable in the Cluster WebUI are as follows.

  • 1.
    Open "Cluster properties" from the configuration mode of the Cluster WebUI.
  • 2.
    Click the "Cloud" tab.
  • 3.
    Click the "Settings" button for "Environment variables at the time of performing AWS-related features" under "Environment variable".
  • 4.
    Click the "Add" button and add HTTP_PROXY, HTTPS_PROXY, and NO_PROXY as the required environment variables.

Environment Variables at the Time of Performing AWS-Related FeatureszoomLarger view

Note：

  • You cannot use both the "Environment variables at the time of performing AWS-related features" and the environment variable configuration file feature at the same time.
  • The environment variable configuration file is for ensuring compatibility with old versions. For EXPRESSCLUSTER X 5.1 and later, using "Environment variables at the time of performing AWS-related features" is recommended for configuring the environment variables.

The AWS-related features that are affected by environment variables are as follows:

・AWS Elastic IP resource
・AWS Virtual IP resource
・AWS Secondary IP resource
・AWS DNS resource
・AWS Elastic IP monitor resource
・AWS Virtual IP monitor resource
・AWS Secondary IP monitor resource
・AWS AZ monitor resource
・AWS DNS monitor resource
・AWS Forced stop resource
・Amazon SNS linkage
・Amazon CloudWatch linkage
・Obtaining cloud environment information with Cluster WebUI

For more setting "Environment variables at the time of performing AWS-related features" information, please refer to the following:

[Reference]
popupDocumentation - Manuals
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Windows > Getting Started Guide
  • -> 6. Notes and Restrictions
  • -> 6.3. Notes when creating the cluster configuration data
  • -> 6.3.12. Environment variables for running AWS-related features
  • EXPRESSCLUSTER X 5.2 > EXPRESSCLUSTER X 5.2 for Linux > Getting Started Guide
  • -> 6. Notes and Restrictions
  • -> 6.4. Notes when creating EXPRESSCLUSTER configuration data
  • -> 6.4.21. Environment variables for running AWS-related features

To set environment variables in EXPRESSCLUSTER X 5.0 and earlier, you must edit the environment variable configuration file. For details on how to edit the file, see the previous article popupWe Tried Building an HA Cluster Using Proxy Server on AWS (Windows/Linux).

Conclusion

This time, we introduced how to set command line options and environment variables when performing AWS-related features using the Cluster WebUI. The settings are easier than those in EXPRESSCLUSTER X 5.0 and earlier, so please use it when you need to set them up.

If you consider introducing the configuration described in this article, you can perform a validation with the popuptrial module of EXPRESSCLUSTER. Please do not hesitate to contact us if you have any questions.