Deployment Manager: Automated VM deployment for SAP NetWeaver on Linux

This guide uses Deployment Manager to deploy all of the required Google Cloud resources to run SAP NetWeaver on Linux, including the Compute Engine virtual machine (VM), the Linux operating system, and the persistent disks. You define the values for the installation, such as machine type, resource names, disk sizes, and so forth, in a Deployment Manager configuration file template.

To use Terraform to automate the deployment of Google Cloud resources to run SAP NetWeaver on Linux, see Terraform: Automated VM deployment for SAP NetWeaver on Linux.

If your SAP NetWeaver installation requires more control over the deployment process than the Deployment Manager template provides, see Manual VM deployment for SAP NetWeaver on Linux.

To deploy a VM that is running Windows, see the Windows deployment guide.

VM configuration deployed by these instructions

The VM that is deployed by these instructions is for use in a 3-tier configuration, where SAP NetWeaver runs on one VM and the database server runs on another.

To set up a 2-tier configuration, where SAP NetWeaver runs on the same VM as the database server, you deploy the database server first and create the VM and the required disk drives for both the database server and for SAP NetWeaver at that time. You then install SAP NetWeaver on the same VM as the database server.

For instructions about deploying the VM for a database server, see the database deployment guide for your database server.

Google Cloud resources deployed by these instructions

The Google Cloud resources that are deployed by Deployment Manager include:

• A VM that uses an SAP-certified version of Linux.
• A persistent disk for the boot disk.
• A persistent disk for SAP binaries.
• A persistent disk for swap space.
• The recommended APIs.
• Google Cloud's Agent for SAP.

The following instructions use Cloud Shell, but if you prefer, you can use the Google Cloud CLI in your local terminal instead.

For more details on planning your implementation, see the Planning guide. For an overview of IT ops for your system, see the Operations guide.

Creating a project

To create a project:

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

5. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

Configuring the gcloud command environment

These instructions use Cloud Shell to enter gcloud commands that deploy or configure your Google Cloud resources. Cloud Shell is accessed through the Google Cloud console in your browser.

Cloud Shell runs on a VM that Google Cloud provisions each time you start Cloud Shell. The first time you use Cloud Shell, Google Cloud also creates a persistent $HOME directory for you, which is restored each time you open Cloud Shell.

The provisioned VM includes the latest Google Cloud CLI. Therefore, the gcloud commands that you use in Cloud Shell are the same as those you would use in a locally installed instance of the gcloud CLI.

If you have the gcloud CLI installed, you can issue the gcloud commands that are used in these instructions from your local machine. However, with a locally installed gcloud CLI you must always make sure that you are using the latest version of the gcloud CLI.

Whether you use Cloud Shell or gcloud CLI, you can set and change the properties of your gcloud command environment and save them as a configuration. Configurations are collections of key-value pairs that influence the behavior of the gcloud commands.

Some basic actions you can take with a configuration in Cloud Shell include:

• Initialize a configuration:

  gcloud init

• Check the settings of your current gcloud configuration:

  gcloud config list

• Switch to the required Cloud project. Replace PROJECT_ID with your Google Cloud project ID.

  gcloud config set project PROJECT_ID

• Set a default region. Replace REGION with a Google Cloud region.

  gcloud config set compute/region REGION

• Set a default zone. Replace ZONE with a Google Cloud zone.

  gcloud config set compute/zone ZONE

• Create a new configuration. Replace NAME with the name for the configuration.

  gcloud config configurations create NAME

For more information about working with configurations, see Managing gcloud CLI configurations.

Creating a network

For security purposes, create a new network. You can control who has access by adding firewall rules or by using another access control method.

If your project has a default VPC network, don't use it. Instead, create your own VPC network so that the only firewall rules in effect are those that you create explicitly.

During deployment, VM instances typically require access to the internet to download Google Cloud's Agent for SAP. If you are using one of the SAP-certified Linux images that are available from Google Cloud, the VM instance also requires access to the internet in order to register the license and to access OS vendor repositories. A configuration with a NAT gateway and with VM network tags supports this access, even if the target VMs do not have external IPs.

To set up networking:

Console

1. In the Google Cloud console, go to the VPC networks page.

   Go to VPC networks

2. Click Create VPC network.
3. Enter a Name for the network.

   The name must adhere to the naming convention. VPC networks use the Compute Engine naming convention.

4. For Subnet creation mode, choose Custom.
5. In the New subnet section, specify the following configuration parameters for a subnet:
   1. Enter a Name for the subnet.
   2. For Region, select the Compute Engine region where you want to create the subnet.
   3. For IP stack type, select IPv4 (single-stack) and then enter an IP address range in the CIDR format, such as 10.1.0.0/24.

      This is the primary IPv4 range for the subnet. If you plan to add more than one subnet, then assign non-overlapping CIDR IP ranges for each subnetwork in the network. Note that each subnetwork and its internal IP ranges are mapped to a single region.

   4. Click Done.
6. To add more subnets, click Add subnet and repeat the preceding steps. You can add more subnets to the network after you have created the network.
7. Click Create.

gcloud

1. Go to Cloud Shell.

   Go to Cloud Shell

2. To create a new network in the custom subnetworks mode, run:

   gcloud compute networks create NETWORK_NAME --subnet-mode custom

   Replace NETWORK_NAME with the name of the new network. The name must adhere to the naming convention. VPC networks use the Compute Engine naming convention.

   Specify --subnet-mode custom to avoid using the default auto mode, which automatically creates a subnet in each Compute Engine region. For more information, see Subnet creation mode.

3. Create a subnetwork, and specify the region and IP range:

   gcloud compute networks subnets create SUBNETWORK_NAME \
       --network NETWORK_NAME --region REGION --range RANGE

   Replace the following:

   • SUBNETWORK_NAME: the name of the new subnetwork
   • NETWORK_NAME: the name of the network you created in the previous step
   • REGION: the region where you want the subnetwork
   • RANGE: the IP address range, specified in CIDR format, such as 10.1.0.0/24

     If you plan to add more than one subnetwork, assign non-overlapping CIDR IP ranges for each subnetwork in the network. Note that each subnetwork and its internal IP ranges are mapped to a single region.

4. Optionally, repeat the previous step and add additional subnetworks.

Setting up a NAT gateway

If you need to create one or more VMs without public IP addresses, you need to use network address translation (NAT) to enable the VMs to access the internet. Use Cloud NAT, a Google Cloud distributed, software-defined managed service that lets VMs send outbound packets to the internet and receive any corresponding established inbound response packets. Alternatively, you can set up a separate VM as a NAT gateway.

Key Point: When you configure Cloud NAT, specify at least 160 as the minimum number of ports per VM. Certain operating system updates run concurrent processes that might exceed the Cloud NAT default for the number of ports, which can result in activation or download errors.

When you create a Cloud NAT instance, specify the number of ports in the Minimum ports per VM field under Advanced configurations on the Create a NAT gateway page in the Google Cloud console.

To create a Cloud NAT instance for your project, see Using Cloud NAT.

After you configure Cloud NAT for your project, your VM instances can securely access the internet without a public IP address.

Adding firewall rules

By default, incoming connections from outside your Google Cloud network are blocked. To allow incoming connections, set up a firewall rule for your VM. Firewall rules regulate only new incoming connections to a VM. After a connection is established with a VM, traffic is permitted in both directions over that connection.

You can create a firewall rule to allow access to specified ports, or to allow access between VMs on the same subnetwork.

Create firewall rules to allow access for such things as:

• The default ports used by SAP NetWeaver, as documented in TCP/IP Ports of All SAP Products.
• Connections from your computer or your corporate network environment to your Compute Engine VM instance. If you are unsure of what IP address to use, talk to your company's network admin.
• Communication between VMs in a 3-tier, scaleout, or high-availability configuration. For example, if you are deploying a 3-tier system, you will have at least 2 VMs in your subnetwork: the VM for SAP NetWeaver, and another VM for the database server. To enable communication between the two VMs, you must create a firewall rule to allow traffic that originates from the subnetwork.
• SSH connections to your VM instance, including SSH from the browser, through port 22.
• Connections to your VM instance from third-party tools, such as a local terminal or PuTTY. Create a rule to allow access for the tool through your firewall. For more information, see Connect to Linux VMs using third-party tools.

Note: The following procedure is a simplified version of the instructions for creating firewall rules. For more detailed instructions, see the Virtual Private Cloud documentation.

To create a firewall rule:

1. In the Google Cloud console, go to the VPC network Firewall page.

   Go to Firewall

2. At the top of the page, click Create firewall rule.

   • In the Network field, select the network where your VM is located.
   • In the Targets field, select All instances in the network.
   • In the Source filter field, select one of the following:
     • IP ranges to allow incoming traffic from specific IP addresses. Specify the range of IP addresses in the Source IP ranges field.
     • Subnets to allow incoming traffic from a particular subnetwork. Specify the subnetwork name in the following subnets field. You can use this option to allow access between the VMs in a 3-tier or scaleout configuration.
   • In the Protocols and ports section, select Specified protocols and ports and specify tcp:PORT_NUMBER;.

3. Click Create to create your firewall rule.

Deploying a Linux VM for SAP NetWeaver with Deployment Manager

The following instructions use Google Cloud console, Cloud Shell, and Deployment Manager to deploy a VM instance with Linux and all of the persistent disks that SAP NetWeaver requires.

To avoid unintentionally exposing your VM instance to the internet, follow these recommendations:

• Use a NAT gateway.
• Create firewall rules that block all external access that you don't require.
• When you create your VMs:
  • Specify a network tag for each VM for use in routing and firewall rules. If you use the Deployment Manager template that Google Cloud provides, specify a tag with networkTag: [TAG].
  • Create the VMs without an external IP. If you use the Deployment Manager templates that Google Cloud provides, specify publicIP: No.

About Deployment Manager

In these instructions, you define the resource options for your installation in a Deployment Manager configuration file template.

Deployment Manager treats all of the resources that are created for your SAP system as a single entity called a deployment. You can view and work with all of the deployments for your project on the Deployments page in the Google Cloud console.

Be aware of the following behaviors when using Deployment Manager:

• Deleting a deployment deletes all of the resources associated with the deployment, including the VMs, the persistent disks, and any SAP systems that are installed on the VM.

• By default, Deployment Manager uses the ACQUIRE resource creation policy. If you specify a VM name that is already in use by another VM in your project, Deployment Manager doesn't create a new VM, but instead adds the existing VM to your new deployment. If your original VM was created by a previous run of Deployment Manager, the VM is associated with two deployments.

  If you then delete the new deployment, the acquired VM is deleted from the deployment that originally created it. To avoid such a scenario, either set the Deployment Manager resource policy to CREATE, or make sure that you use unique resource names in your new deployment.

  For information about the policies you can use while creating resources with Deployment Manager and how to specify them, see the Deployment Manager documentation.

Deployment procedure

1. Open Cloud Shell.

   Go to Cloud Shell

2. Download the template.yaml configuration file template to your working directory:

   wget https://storage.googleapis.com/cloudsapdeploy/deploymentmanager/latest/dm-templates/sap_nw/template.yaml

3. Optionally, rename the template.yaml file to identify the configuration it defines. For example, nw-sles12sp3.yaml.

4. To open the template.yaml file in Cloud Shell code editor, click the pencil () icon in the upper right corner of Cloud Shell terminal window to launch the editor.

5. In the template.yaml file, update the following property values by replacing the brackets and their contents with the values for your installation.

   Property	Data type	Description
   type	String	Specifies the location, type, and version of the Deployment Manager template to use during deployment. The YAML file includes two type specifications, one of which is commented out. The type specification that is active by default specifies the template version as latest. The type specification that is commented out specifies a specific template version with a timestamp. If you need all of your deployments to use the same template version, use the type specification that includes the timestamp.
   instanceName	String	The name of the VM instance on which SAP NetWeaver will be installed. The name must be 13 characters or less and be specified in lowercase letters, numbers, or hyphens. Use a name that is unique within your project.
   instanceType	String	The type of Compute Engine virtual machine that you need. If you need a custom VM type, specify a small predefined VM type and, after deployment is complete, customize the VM as needed.
   zone	String	The zone in which you are deploying your SAP NetWeaver. It must be in the same region that you selected for your subnetwork.
   subnetwork	String	The name of the subnetwork that you created in a previous step. If you are deploying to a shared VPC, specify this value as [SHAREDVPC_PROJECT]/[SUBNETWORK]. For example, myproject/network1.
   linuxImage	String	The name of the Linux operating-system image or image family that you are using with SAP NetWeaver. To specify an image family, add the prefix family/ to the family name. For example, family/rhel-7-sap-hana. For the list of available image families, see the Images page in the Google Cloud console.
   linuxImageProject	String	The Google Cloud project that contains the image you are going to use. This project might be your own project or a Google Cloud image project, such as rhel-sap-cloud or suse-sap-cloud. For a list of Google Cloud image projects, see the Images page in the Compute Engine documentation.
   usrsapSize	Integer	The size of the `/usr/sap` disk. The minimum size is 8 GB.
   sapmntSize	Integer	The size of the `/sapmnt` disk. The minimum size is 8 GB.
   swapSize	Integer	The size of the swap volume. The minimum size is 1 GB.
   networkTag	String	Optional. A network tag that represents your VM instance for firewall or routing purposes. If you specify `publicIP: No` and do not specify a network tag, be sure to provide another means of access to the internet.
   publicIP	Boolean	Optional. Determines whether a public IP address is added to your VM instance. The default is Yes. Note: Do not specify No unless you have a NAT gateway configured with a network tag defined for the VM or you have provided the VM with another route to the internet. If there is no route to the internet, the installation fails.
   sap_deployment_debug	Boolean	Optional. If this value is set to Yes, the deployment generates verbose deployment logs. Do not turn this setting on unless a Google support engineer asks you to enable debugging.

   The following configuration file creates a VM that is configured to run SAP NetWeaver. The configuration file directs Deployment Manager to deploy the n1-standard-16 VM that is running a SLES 12 SP2 operating system. The VM includes all of the directories that are required in order to run SAP NetWeaver.

   resources:
   - name: sap_nw
     type: https://storage.googleapis.com/cloudsapdeploy/deploymentmanager/latest/dm-templates/sap_nw/sap_nw.py
     #
     # By default, this configuration file uses the latest release of the deployment
     # scripts for SAP on Google Cloud.  To fix your deployments to a specific release
     # of the scripts, comment out the type property above and uncomment the type property below.
     #
     # type: https://storage.googleapis.com/cloudsapdeploy/deploymentmanager/202103310846/dm-templates/sap_nw/sap_nw.py
     properties:
       instanceName: ex-vm-nw-lin
       instanceType: n1-standard-16
       zone: us-central1-f
       subnetwork: example-sub-network-sap
       linuxImage: family/sles-12-sp2-sap
       linuxImageProject: suse-sap-cloud
       usrsapSize: 15
       sapmntSize: 15
       swapSize: 24

6. Create the VM instance:

   gcloud deployment-manager deployments create [DEPLOYMENT_NAME] --config [TEMPLATE_NAME].yaml

   where:

   • [DEPLOYMENT_NAME] represents the name of your deployment.
   • [TEMPLATE_NAME] represents the name of your template.yaml file.

   The preceding command invokes the Deployment Manager, which deploys the VM according to the specifications in your template.yaml file. The process may take a few minutes. To check the progress of your deployment, follow the steps in the next section.

7. After the VM instance deploys, if you need Compute Engine to save the boot disk in the event the VM instance is deleted:

   1. In the Google Cloud console, go to the VM Instances page.

      Go to the VM Instances page

   2. To open the VM instance details page for your VM instance, click the name of the VM instance.

   3. Under Boot disk and local disks, clear the Delete boot disk when instance is deleted checkbox.

Verifying deployment

To verify deployment, you check the deployment logs in Cloud Logging and check the configuration of the VM.

Check the logs

1. In the Google Cloud console, open Cloud Logging to monitor installation progress and check for errors.

   Note: You might incur costs when completing this step in Cloud Logging. For more information, see Cloud Logging pricing.

   Go to Cloud Logging

2. Filter the logs:

   Logs Explorer

   1. In the Logs Explorer page, go to the Query pane.

   2. From the Resource drop-down menu, select Global, and then click Add.

      If you don't see the Global option, then in the query editor, enter the following query:

      resource.type="global"
      "Deployment"
      

   3. Click Run query.

   Legacy Logs Viewer

   • In the Legacy Logs Viewer page, from the basic selector menu, select Global as your logging resource.

3. Analyze the filtered logs:

   • If "--- Finished" is displayed, then the deployment processing is complete and you can proceed to the next step.

   • If you see a quota error:

     1. On the IAM & Admin Quotas page, increase any of your quotas that do not meet the SAP NetWeaver requirements that are listed in the SAP NetWeaver planning guide.

     2. On the Deployment Manager Deployments page, delete the deployment to clean up the VMs and persistent disks from the failed installation.

     3. Rerun your deployment.

Check the configuration of the VM

1. After the VM instance deploys, connect to your VM by using ssh.

   1. If you haven't already done so, create a firewall rule to allow an SSH connection on port 22.

   2. Go to the VM Instances page.

      Go to VM instances

   3. Click SSH for your VM instance, or you can use your preferred SSH method.

      

2. Change to the root user.

   sudo su -

3. At the command prompt, enter df -h. Ensure that you see output similar to the following.

   

4. Confirm that the swap directory was created:

   cat /proc/meminfo | grep Swap

   You see results similar to the following example:

   

If any of the validation steps show that the installation failed:

1. Correct the error.
2. On the Deployments page, delete the deployment to clean up the VMs and persistent disks from the failed installation.
3. Rerun your deployment.

Connecting to your VM

If you have defined a firewall rule that allows access on port 22, you can connect to a Linux VM using common SSH tools.

Google Cloud provides two connection methods. You can connect through the Google Cloud console or you can connect from a terminal by using a gcloud command.

Console

To connect by using ssh directly from your browser in the Google Cloud console:

1. In the Google Cloud console, go to the VM instances page.

   Go to VM instances

2. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.

   

gcloud

The Google Cloud CLI manages your SSH keys for you by generating and applying new project-wide SSH keys when you need them.

Connect to your VM instance:

gcloud compute --project "[VM_GCP_PROJECT]" ssh --zone "[VM_ZONE]" "[VM_NAME]"

where:

• [VM_CGP_PROJECT] is the name of the Google Cloud project in which you have created your VM.
• [VM_ZONE] is the zone in which you have located your VM.
• [VM_NAME] is the name of your VM instance.

After you submit this command, the terminal is connected to your VM on Google Cloud and you can run commands on your Linux VM. When you are done, use the exit command to disconnect from the VM.

Note: New VMs can take some time to boot up before an SSH connection is established. If you fail to connect to a new instance, retry after a few minutes.

You can also generate a new key-pair for your Linux VM and apply it to your project, which allows you to connect using third-party tools such as PuTTY on Windows workstations. For more details, see Create SSH keys.

Other connection options, which aren't discussed here, are also possible.

For more detailed information about connecting to a Linux VM on Google Cloud, see Connecting to Linux instances.

Setting up the database

If you haven't yet deployed your database on Google Cloud, follow the instructions for setting up your database in both the Google Cloud deployment guide for your database, and in the database documentation that is provided by your database vendor.

Google Cloud provides deployment guides for the following SAP-certified databases:

• SAP HANA guides
• SAP ASE guides
• SAP MaxDB guides
• IBM Db2 guides
• Windows SQL Server guide: when SAP NetWeaver is running on Linux, Windows SQL Server is supported only in 3-tier architectures.

When SAP NetWeaver and the database server are running on different VMs in a 3-tier architecture, make sure that your firewall rules are defined to allow communication between the VMs.

Installing the Cloud Logging agent

The Cloud Logging agent provides you with a solution for Google Cloud system-activity logging, including operating system events and, if you are using SAP HANA, SAP HANA events. The Cloud Logging agent is an optional but recommended component. See the SAP NetWeaver on Google Cloud operations guide for more information about Google Cloud logging.

To install the Cloud Logging agent in your new VM, see the instructions for Linux and Windows in Installing the agent.

Installing SAP NetWeaver

For instructions on installing SAP NetWeaver on your new VM, see the SAP help portal and the SAP NetWeaver Master Guide.

Important: The Software Provisioning Manager (SWPM) chooses the disk drive with the most free space as an installation suggestion for each component. On Google Cloud, it's important that you don't accept the defaults. Be sure to assign the disks to their proper roles in the SWPM dialog boxes.

After you install SAP NetWeaver:

1. Update the SAP kernel to the minimum supported patch level.

   For details on the supported SAP kernel patch levels, see SAP Note 2446441 - Linux on Google Cloud (IaaS): Adaptation of your SAP License.

2. Install your permanent SAP NetWeaver license.

   For more information from SAP about managing your SAP NetWeaver licenses, see SAP Licensing Procedure.

Installing the SAP Host Agent

The SAP Host Agent has been enhanced for running on Google Cloud. Ensure that you run at least the minimum SAP Host Agent version required for the Google Cloud environment.

For details, refer to the following SAP Notes:

• SAP Note 2460297 - SAP on Linux on Google Cloud Platform: Enhanced Monitoring.
• To update your SAP Host Agent by default on a regular basis, see SAP Note 1473974 - Using the SAP Host Agent Auto Upgrade Feature.

Validate your installation of Google Cloud's Agent for SAP

After you have deployed a VM and installed your SAP system, validate that Google Cloud's Agent for SAP is functioning properly.

Verify that Google Cloud's Agent for SAP is running

To verify that the agent is running, follow these steps:

1. Establish an SSH connection with your host VM instance.

2. Run the following command:

   systemctl status google-cloud-sap-agent

   If the agent is functioning properly, then the output contains active (running). For example:

   google-cloud-sap-agent.service - Google Cloud Agent for SAP
   Loaded: loaded (/usr/lib/systemd/system/google-cloud-sap-agent.service; enabled; vendor preset: disabled)
   Active:  active (running)  since Fri 2022-12-02 07:21:42 UTC; 4 days ago
   Main PID: 1337673 (google-cloud-sa)
   Tasks: 9 (limit: 100427)
   Memory: 22.4 M (max: 1.0G limit: 1.0G)
   CGroup: /system.slice/google-cloud-sap-agent.service
          └─1337673 /usr/bin/google-cloud-sap-agent
   

If the agent isn't running, then restart the agent.

Verify that SAP Host Agent is receiving metrics

To verify that the infrastructure metrics are collected by Google Cloud's Agent for SAP and sent correctly to the SAP Host Agent, follow these steps:

1. In your SAP system, enter transaction ST06.

2. In the overview pane, check the availability and content of the following fields for the correct end-to-end setup of the SAP and Google monitoring infrastructure:

   • Cloud Provider: Google Cloud Platform
   • Enhanced Monitoring Access: TRUE
   • Enhanced Monitoring Details: ACTIVE

Troubleshooting

This section contains information about how to correct common issues.

Troubleshooting communication problems to the database server

If you are setting up a 3-tier SAP system and having connection issues between your VMs, ensure that you have created a firewall rule to allow traffic between VMs on your subnetwork.

Troubleshooting connecting to your VM

If you are having issues connecting to your VM through ssh, ensure that you have created a firewall rule to open port 22 on the Google Cloud network you are using.

For other possible issues, see Known issues for SSH from the browser.

Troubleshooting Google Cloud's Agent for SAP

To troubleshoot Google Cloud's Agent for SAP, see the Google Cloud's Agent for SAP troubleshooting guide.