-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #394 from ant-media/create-gcp-documents
GCP Documents
- Loading branch information
Showing
26 changed files
with
304 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "label": "GCP", | ||
| "position": 4, | ||
| "link": { | ||
| "type": "generated-index", | ||
| "description": "Deploy Ant Media Server at GCP." | ||
| } | ||
| } |
163 changes: 163 additions & 0 deletions
163
docs/guides/clustering-and-scaling/gcp/ams-cluster-with-jinja-template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| --- | ||
| title: Cluster with GCP Jinja Template | ||
| description: Cluster Deployment with GCP Jinja Template | ||
| keywords: [AMS Cluster Deployment on GCP, Ant Media Server Documentation, Ant Media Server Tutorials] | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| In this guide, we’ll dive into how to use Jinja Templates and Google Cloud Deployment Manager to streamline the deployment of Ant Media Server clusters on Google Cloud Platform (GCP). We’ll cover the essentials of both Jinja Templates and Deployment Manager, explore how these tools integrate seamlessly, and provide a step-by-step walkthrough to help you deploy an Ant Media Server cluster with confidence and ease. | ||
|
|
||
| ## What is Google Deployment Manager and Jinja Template? | ||
|
|
||
| Let's first learn about the Google Deployment Manager and GCP Jinja Template. | ||
|
|
||
| ### Google Deployment Manager | ||
| It is an infrastructure management service provided by Google Cloud Platform (GCP). It allows you to define the desired state of your cloud resources using configuration files, enabling you to automate the creation, deployment, and updates of complex cloud infrastructure. | ||
|
|
||
| ### Jinja | ||
| It is a templating engine for Python that allows for the creation of dynamic configuration files. In the context of GCP Deployment Manager, Jinja Template enables you to generate resource configurations based on predefined templates, incorporating variables, loops, and logic to tailor deployments to specific requirements. | ||
|
|
||
| ## Prerequisites | ||
| Before you begin the deployment process, ensure you have the following prerequisites in place: | ||
|
|
||
| * **Google Cloud Platform Account:** Ensure that you have access to a Google Cloud Platform account with the necessary permissions to create and manage resources. If you don’t have an account yet, you can sign up for a free trial or a paid subscription on the Google Cloud Platform website. | ||
|
|
||
| * **Google Cloud SDK (gcloud CLI):** Install the [Google Cloud SDK](https://cloud.google.com/sdk/docs/install) and ensure that the gcloud command-line tool is available in your environment. This tool will be used to interact with Google Cloud Platform (GCP) resources and services. | ||
|
|
||
| * **Enable Compute Engine API:** Make sure to enable the [Compute Engine API](https://cloud.google.com/compute/docs/reference/rest/v1) in your GCP project. This API is required to create and manage virtual machine instances, which are essential for hosting Ant Media Server clusters. | ||
|
|
||
| * **Infrastructure Manager API:** Enable the [Infrastructure Manager API](https://cloud.google.com/infrastructure-manager/docs/reference/rest) in your GCP project. This API allows you to create and manage infrastructure resources using tools like Google Deployment Manager. | ||
|
|
||
| * **Ant Media Server Marketplace Image:** Ant Media Server Marketplace Image will serve as the base for your Ant Media Server cluster. To create an image, you first need to launch an Ant Media Server instance from GCP Marketplace and then create an image from that. Please follow the instructions in [Step 2 of this blog post](https://antmedia.io/scale-ant-media-server-google-cloud-platform-guide/) to create an image. | ||
|
|
||
| :::info | ||
| Please note the name of the image, as it will be used in the configuration file to create the cluster. For this demo, I will name the image **ams-latest** | ||
| ::: | ||
|
|
||
| * **Ant Media Server Cluster GCP Jinja Template:** Get the Ant Media Server Cluster [GCP Jinja Template](https://github.com/ant-media/Scripts) from the GitHub repository. This template contains the configuration settings for deploying an Ant Media Server cluster on GCP using Google Deployment Manager and Jinja Templates. | ||
|
|
||
| ## Accessing the Google Cloud Account | ||
|
|
||
| Now that we have all the prerequisites covered, let’s access the GCP account to get started. | ||
|
|
||
| * Login to your GCP account using the gcloud CLI tool in the terminal | ||
|
|
||
| ```bash | ||
| gcloud auth login | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| * Go to the above-displayed URL in your browser, follow the prompts, and enter the verification code, and you will be logged in to your gCloud environment. | ||
|
|
||
| * You can create a new project for the deployment or if you already have a project created, you can switch to the existing project with | ||
|
|
||
| ```bash | ||
| gcloud config set project YOUR_PROJECT_ID | ||
| ``` | ||
|
|
||
| ## Deploy the Cluster | ||
|
|
||
| To deploy the Ant Media Cluster, we will quickly edit a couple of files and then launch it with a single command. | ||
|
|
||
| ### Step 1: Edit the antmedia.yaml file | ||
|
|
||
| * Open the **antmedia.yaml** file to edit from the `gcp-jinja-template` files you downloaded with your favorite editor. | ||
| * Adjust the region, zone, and instance type settings according to your structure and save it | ||
|
|
||
| ```properties: | ||
| default_zone: us-central1-a | ||
| default_region: us-central1 | ||
| mongodb_machine_type: e2-standard-2 | ||
| origin_machine_type: c2d-standard-4 | ||
| edge_machine_type: c2d-standard-4 | ||
| ``` | ||
|
|
||
| * If you have named your Ant Media Server Marketplace image something other than ams-latest, you can pass it to the properties as | ||
|
|
||
| ```image_id: "image-name"``` | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Edit the antmedia-loadbalancer-template.jinja file | ||
|
|
||
| Edit the **antmedia-loadbalancer-template.jinja** file to add the certificate content created for your wildcard domain. | ||
|
|
||
| ``` | ||
| certificate: fullchain.pem or certificate | ||
| privateKey: private key | ||
| ``` | ||
| ``` | ||
| – name: ams-ssl-cert-{{ scenario }} | ||
| type: compute.v1.sslCertificate | ||
| properties: | ||
| certificate: | | ||
| —–BEGIN CERTIFICATE—– | ||
| Your Certificate | ||
| —–END CERTIFICATE—– | ||
| privateKey: | | ||
| —–BEGIN PRIVATE KEY—– | ||
| Your Private Key | ||
| —–END PRIVATE KEY—– | ||
| ``` | ||
|
|
||
| * Make sure that your certificate and private key are properly indented to avoid any errors. | ||
|
|
||
| * Save the file and exit from the editor. | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Launch the Cluster | ||
|
|
||
| Once the above configurations are complete, deploy the Ant Media Server Cluster using **gcloud** cli as follows:. | ||
|
|
||
| ```bash | ||
| gcloud deployment-manager deployments create ams-cluster --config antmedia.yaml | ||
| ``` | ||
|
|
||
| This step will take advantage of the automatic scaling and management features provided by GCP and create the Ant Media Server Cluster using a Jinja template. | ||
|
|
||
|  | ||
|
|
||
| * In case the deployment is aborted or halted due to any issues, you can check the deployment status with | ||
|
|
||
| ```bash | ||
| gcloud deployment-manager deployments describe ams-cluster | ||
| ``` | ||
|
|
||
| * If the deployment failed and you need to redeploy from scratch, you can delete the failed deployment and create it again | ||
|
|
||
| ```bash | ||
| gcloud deployment-manager deployments delete ams-cluster | ||
| gcloud deployment-manager deployments create ams-cluster --config antmedia.yaml | ||
| ``` | ||
|
|
||
| **Congratulations!** Your very own Ant Media Server Cluster is ready using Google Deployment Manager and the Jinja template. | ||
|
|
||
| ## Access the Ant Media Server Cluster | ||
|
|
||
| Now that your Ant Media Server cluster is created and ready, let’s connect to it. | ||
|
|
||
| * Go to your GCP account console > Load Balancing and under Load Balancers. | ||
|
|
||
| * There will be two load balancers, one of them is Edge and another one is Origin, named ams-edge and ams-origin. | ||
|
|
||
| * You can connect to your cluster via the Load Balancer Public IP or update your DNS records based on the certificate hostname. | ||
|
|
||
| Ant Media Server LBs | ||
|  | ||
|
|
||
| * Once you reach the Load Balancer IP address, you will see the Ant Media Server Web panel dashboard and can create your login credentials. | ||
|
|
||
| Ant Media Server dashboard | ||
|  | ||
|
|
||
| ## WebRTC Publish and Play | ||
|
|
||
| Now that everything is up and running, let’s explore our collection of [WebRTC samples](https://antmedia.io/webrtc-samples/) to publish and play with WebRTC and get started. | ||
|
|
||
| Webrtc sample publish page | ||
|  | ||
|
|
||
| Webrtc player page | ||
|  |
131 changes: 131 additions & 0 deletions
131
docs/guides/clustering-and-scaling/gcp/gcp-cluster-deployment.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| --- | ||
| title: GCP Installation | ||
| description: GCP Installation | ||
| keywords: [GCP, GCP Installation, Ant Media Server Documentation, Ant Media Server Tutorials, Google Cloud Platform installation] | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # Google Cloud Platform (GCP) | ||
|
|
||
| In this comprehensive guide, we’ll walk you through the steps to efficiently expand your Ant Media Server infrastructure on GCP, ensuring optimal performance and an exceptional viewing experience for your audience. | ||
|
|
||
| Let’s move on to the installation. | ||
|
|
||
| After logging into Google Cloud Platform, create a project. We created a project named "antmedia-test" for testing purposes. | ||
|
|
||
| ### Step 1: Install MongoDB server | ||
|
|
||
| To create an instance in Google Cloud Platform: | ||
|
|
||
| 1. Go to VM Instances > CREATE INSTANCE, and select Ubuntu 22.04 as the boot disk. | ||
|
|
||
| 2. Under Advanced Options, navigate to the Management tab. Add the following lines to the Automation section: | ||
|
|
||
| ```shell | ||
| #!/bin/bash | ||
| wget https://raw.githubusercontent.com/ant-media/Scripts/master/install_mongodb.sh && chmod +x install_mongodb.sh | ||
| ./install_mongodb.sh | ||
| ``` | ||
|
|
||
| 3. Click Create to complete the process. Once the instance is created, make sure to note down its private IP address. | ||
|
|
||
| ### Step 2: Install Ant Media Server Enterprise Edition | ||
|
|
||
| To deploy Ant Media Server Enterprise Edition as a cluster on GCP, start by launching Ant Media Server Enterprise Edition through the Marketplace. For detailed steps, refer to this blog post on launching AMS through the Marketplace. | ||
|
|
||
|  | ||
|
|
||
| After the deployment, stop the instance. | ||
|
|
||
| Next, go to Images > CREATE IMAGE and select the instance you just set up as the Source disk. | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Create an Instance Template | ||
|
|
||
| After the image creation process is complete, proceed to the Instance Templates > CREATE INSTANCE TEMPLATE menu. | ||
|
|
||
| Select the instance type | ||
|  | ||
|
|
||
| On the same screen, navigate to the Boot Disk section and click on Change > Custom Images. Then, select the image you created in the previous step. | ||
|
|
||
|  | ||
|
|
||
| After that, go to Advanced Options > Management Tab and add the following startup script to the Automation section: | ||
|
|
||
| ```shell | ||
| #!/bin/bash | ||
| rm -rf /usr/local/antmedia/conf/instanceId | ||
| rm -rf /usr/local/antmedia/*.db.* | ||
| rm -rf /usr/local/antmedia/*.db | ||
| cd /usr/local/antmedia | ||
| ./change_server_mode.sh cluster 10.128.0.5 | ||
| ``` | ||
|
|
||
| In the script, please replace the private IP of your MongoDB created in Step 1. Click the Create button to create the template. | ||
|
|
||
| ### Step 4: Create the Instance group | ||
|
|
||
| Navigate on Google Cloud to Compute Engine > Instance Groups > CREATE INSTANCE GROUP. Then, select the name and template as shown in the screenshot, and choose Multiple Zones for the Location. | ||
|
|
||
|  | ||
|
|
||
| For auto-scaling, specify the minimum and maximum instance counts you want to set up, then configure the CPU Utilization to 60% and click on the Create button. | ||
|
|
||
| Then repeat the same process for the Edge group as well. | ||
|
|
||
| ### Step 5: Create a Load Balancer | ||
|
|
||
| The autoscaling groups are now created. Let’s move on to configuring the Load Balancer to distribute the load. | ||
|
|
||
| In the search bar, type “Load Balancer” and open the “Load balancing” service, then click on **CREATE LOAD BALANCER** and select **Application Load Balancer**. | ||
|
|
||
|  | ||
|
|
||
| In the Load Balancer menu, after selecting the Name and Protocol, go to the certificate section and create a new certificate by choosing “CREATE A NEW CERTIFICATE.” | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| Then, fill in the required fields and create the certificate. You can also use your own SSL certificate by uploading it. After that, click on the “Backend configuration” section. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| In the upcoming screen, we will create the Backend Pool (both Origin and Edge) and Health Check. | ||
|
|
||
| In the same backend configuration, to create the Health Check configuration, click on Health Check > CREATE HEALTH CHECK and add it as shown below: | ||
|
|
||
|  | ||
|
|
||
| Click on Create to finalize the configuration for both the Backend and the Health check. Then, click Create again to complete the Load Balancer configuration. | ||
|
|
||
| Repeat these steps for the Edge side as well. | ||
|
|
||
| :::info | ||
| If the Load Balancers cannot access the Backend servers, you should add a firewall rule as shown below. | ||
| ::: | ||
|
|
||
| Go to VPC Network > Firewall > Create firewall Rule and add the rule as shown below. Now the load balancer should be able to access the Ant Media Server Backend servers. | ||
|
|
||
| You can allow all IPs by adding the 0.0.0.0/0 CIDR block if required. | ||
|
|
||
|  | ||
|
|
||
| ### Step 6: Configure Firewall rule for Ant Media Servers | ||
|
|
||
| For TCP port 5000 and UDP ports 50000–60000, go to VPC Network > Firewall > Create firewall rule and add the rule as shown in the image below. | ||
|
|
||
|  | ||
|
|
||
| Finally, in your DNS management, define the IP addresses of both the origin and edge load balancers. | ||
|
|
||
| That’s it! You’re all set. You can now access the Ant Media Server servers to publish, and play the streams using either the origin or edge group. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
Binary file added
BIN
+355 KB
static/img/clustering-and-scaling/gcp-jinja-cluster/AMS new account dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+48.7 KB
static/img/clustering-and-scaling/gcp-jinja-cluster/gcp-certificates-1536x431.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+238 KB
...mg/clustering-and-scaling/gcp-jinja-cluster/gcp-cluster-attributes-1536x883.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+331 KB
static/img/clustering-and-scaling/gcp-jinja-cluster/gcp-jina-cluster-creation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+139 KB
...ic/img/clustering-and-scaling/gcp-jinja-cluster/gcp-load-balancers-1536x504.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+61.5 KB
static/img/gcp-installation/antmedia-gcp-marketplace-image-eleven.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+69.6 KB
static/img/gcp-installation/antmedia-gcp-marketplace-image-fifteen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+514 KB
static/img/gcp-installation/antmedia-gcp-marketplace-image-fourteen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+105 KB
static/img/gcp-installation/antmedia-gcp-marketplace-image-thirteen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+73.8 KB
static/img/gcp-installation/antmedia-gcp-marketplace-image-two-1024x496.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.