[master]Add Ballerina Deployment Guide #9660

lnash94 · 2025-01-03T09:23:46Z

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Fixes ##9059

Address all the review suggestion in here : #9621

Checklist

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

…t.md

shafreenAnfar · 2025-01-22T08:55:14Z

In the VM deployment, I think we need the CD part.
When showing the GraalVM option I think we can mention, it is a replacement to the usually build step.

Talked about this with @lnash94

lnash94 · 2025-01-24T04:01:18Z

Please note that the VM CD task will be added after completing the flow testing. Therefore, we will resume this work once the MI release is completed. :)

anupama-pathirage · 2025-02-04T21:58:05Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+
+Use the `bal build` command to build the Ballerina package. This will generate Kubernetes YAML files and Docker container artifacts.
+
+>**Note:** For macOS users with Apple Silicon chips, it is necessary to set the environment variable DOCKER_DEFAULT_PLATFORM to linux/amd64 before building the image. This requirement exists because the Ballerina Docker image does not currently support Apple Silicon chips.


Suggested change

>**Note:** For macOS users with Apple Silicon chips, it is necessary to set the environment variable DOCKER_DEFAULT_PLATFORM to linux/amd64 before building the image. This requirement exists because the Ballerina Docker image does not currently support Apple Silicon chips.

>**Note:** For macOS users with Apple Silicon chips, it is necessary to set the environment variable `DOCKER_DEFAULT_PLATFORM` to `linux/amd64` before building the image. This requirement exists because the Ballerina Docker image does not currently support Apple Silicon chips.

anupama-pathirage · 2025-02-04T21:58:51Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+- **Step 06:** Deploy the application to a Kubernetes cluster by applying the Kubernetes YAML configuration files generated by the Ballerina build in Step 2.
+>**Note:** Replace <path to generated artifacts> with the actual path to the Kubernetes YAML files generated by the Ballerina build command (e.g., target/kubernetes).
+
+See [Code to Cloud deployment](https://ballerina.io/learn/code-to-cloud-deployment/) for more information on deployment options in Kubernetes and Docker.


Are we going to have https://ballerina.io/learn/code-to-cloud-deployment/ pages as well after these changes?

anupama-pathirage · 2025-02-04T22:01:06Z

swan-lake/development-tutorials/deployment-guide/serverless-deployment.md

+
+For more reference,
+- See [AWS Lambda](https://ballerina.io/learn/aws-lambda/) for more information.
+- See [Azure Functions](https://ballerina.io/learn/azure-functions/) for information about deployment options that can be used in Azure Functions.


Are we going to have above two pages in the learn section after these changes? If so what is the landing page location? And how do we handle the information loss (i.e. I see more information on those pages like supported triggers etc)

anupama-pathirage · 2025-02-04T22:04:50Z

swan-lake/development-tutorials/deployment-guide/virtual-machine-deployment.md

+3. Install any other dependencies your Ballerina service might need (e.g., database drivers, libraries).
+
+4. Write Ballerina code.
+      **service.bal**


Check the above

anupama-pathirage · 2025-02-04T22:06:13Z

swan-lake/development-tutorials/deployment-guide/virtual-machine-deployment.md

+      - Ensure the server meets the hardware requirements for your application (CPU, memory, disk space, etc.).
+      - Configure the server OS (Linux is recommended for production).
+
+2. Install the Ballerina distribution from [the Ballerina Installation options.](https://ballerina.io/downloads/)


Suggested change

2. Install the Ballerina distribution from [the Ballerina Installation options.](https://ballerina.io/downloads/)

2. Install [Ballerina](https://ballerina.io/downloads/).

anupama-pathirage · 2025-02-04T22:08:35Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+> **Tip:** you can access your service locally via `kubectl port-forward`
+ `$ kubectl port-forward svc/hello-k8s-svc  8081:8080`
+
+Test the service using curl


Suggested change

Test the service using curl

Test the service using cURL.

anupama-pathirage · 2025-02-04T22:10:23Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+
+1. Create a new Ballerina package.
+
+$ bal new hello_k8s


Missing ``` for code segment?

anupama-pathirage · 2025-02-04T22:12:18Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+    hello-k8s-svc-local   NodePort    10.99.245.41    <none>        9090:30342/TCP,9091:30515/TCP   66s
+    kubernetes            ClusterIP   10.96.0.1       <none>        443/TCP                         130m
+    ```
+  - Execute the curl http://192.168.49.2:30342/helloWorld/greeting command to access the deployed service via cURL.


Suggested change

- Execute the curl http://192.168.49.2:30342/helloWorld/greeting command to access the deployed service via cURL.

- Execute the following command to access the deployed service via cURL.

anupama-pathirage · 2025-02-04T22:13:12Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

@@ -0,0 +1,354 @@
+---


@sm1990 Sometimes I am getting the following error when trying to render this page locally. Any idea?

anupama-pathirage · 2025-02-04T22:13:56Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+          kubectl apply -f <path to generated artifacts>
+```
+The push event can initiate a workflow to the deployment process to the Kubernetes cluster.
+- **Step 02:** This step builds the Ballerina project, compiling the source code and preparing the necessary artifacts for deployment in Kubernetes.


What is the step 1?

anupama-pathirage · 2025-02-04T22:15:31Z

swan-lake/development-tutorials/deployment-guide/serverless-deployment.md

+}
+```
+
+3. Use `bal build` for generating the AWS Lambda artifacts.


Suggested change

3. Use `bal build` for generating the AWS Lambda artifacts.

3. Use `bal build` to generate the AWS Lambda artifacts.

anupama-pathirage · 2025-02-04T22:16:16Z

swan-lake/development-tutorials/deployment-guide/serverless-deployment.md

+$ bal build --cloud="aws_lambda"
+```
+
+4. Execute the AWS CLI command to deploy the function, here it creates and publishes the functions by replacing the respective AWS, $LAMBDA_ROLE_ARN, $REGION_ID, and $FUNCTION_NAME values given in the command with your values.


consider rewriting the sentence to avoid , here

anupama-pathirage · 2025-02-04T22:17:11Z

swan-lake/development-tutorials/deployment-guide/serverless-deployment.md

+
+This example demonstrates how to write a simple echo function in Azure Functions using Ballerina, where triggers 
+are represented by listeners attaching an `af:HttpListener` to a service that implies an HTTP trigger. 
+The resource method behaves like a `ballerina/http` service, In the provided code sample, there's an empty service path and a resource path


Are we starting a new sentence from In the?

anupama-pathirage · 2025-02-04T22:17:42Z

swan-lake/development-tutorials/deployment-guide/serverless-deployment.md

+
+1. Set up the prerequisites by following [these instructions.](https://ballerina.io/learn/azure-functions/#set-up-the-prerequisites)
+
+2. Here is an example Ballerina code.


Suggested change

2. Here is an example Ballerina code.

2. Here is an sample Ballerina code.

anupama-pathirage · 2025-02-04T22:19:24Z

@lnash94 Can you please schedule a meeting to discuss the above points? Specially the current code to cloud page positioning etc.

…-dev-website into add-guide-line

anuruddhal · 2025-02-06T04:43:24Z

swan-lake/development-tutorials/deployment-guide/deployment-guidelines-overview.md

+| Ballerina Swan Lake version                                                             | Compatible Java version |
+|-----------------------------------------------------------------------------------------|-------------------------|
+| Ballerina Swan Lake (2201.0.0) up to Ballerina Swan Lake Update 7 (2201.7.0)            | JDK Temurin 11          |
+| Ballerina Swan Lake Update 8 (2201.8.0) up to Ballerina Swan Lake Update 10 (2201.10.0) | JDK Temurin 17.0.7      |


Shall we remove the specific versions JDK Temurin 17.0.7 -> JDK Temurin 17.x ?

anuruddhal · 2025-02-06T04:52:28Z

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md

+> **Tip:** You can build the GraalVM executable in Kubernetes.
+> 
+>  GraalVM enhances Kubernetes deployments of Ballerina applications by enabling faster startup times and reduced memory usage. These advantages make it ideal for microservices workloads that demand rapid scaling and minimal resource consumption in a containerized environment. GraalVM’s native image feature uses ahead-of-time compilation, producing lightweight containers and improving Kubernetes deployment efficiency. The GraalVM build is best suited for deployments that prioritize fast scaling and reduced resource usage, while the standard JVM build is more appropriate for services that do not require such optimizations.
+>  Execute the command below to build a Ballerina package.


Let's add a line saying the build time will be higher for Graal VM builds.

lnash94 added 6 commits November 25, 2024 18:46

Add ballerina deployment guide

18e1edd

Update the deployment guide with links

baeda17

Fix review suggestions

6dd8e82

Fix demo review suggestions

d0e5438

Fix review suggestions

627c72b

Re-order of the tile and left nav

833c8d0

lnash94 requested review from MaryamZi, sm1990 and keizer619 as code owners January 3, 2025 09:23

lnash94 mentioned this pull request Jan 3, 2025

[master]Add Ballerina Deployment Guide #9621

Closed

13 tasks

MaryamZi requested review from anuruddhal and anupama-pathirage January 3, 2025 09:31

sm1990 reviewed Jan 8, 2025

View reviewed changes

swan-lake/development-tutorials/deployment-guide/k8s-deployment.md Outdated Show resolved Hide resolved

Update swan-lake/development-tutorials/deployment-guide/k8s-deploymen…

ae54be7

…t.md

sm1990 requested a review from shafreenAnfar January 17, 2025 04:21

anupama-pathirage reviewed Feb 4, 2025

View reviewed changes

lnash94 added 2 commits February 5, 2025 13:45

Fix review suggestions.

1a79697

Merge branch 'add-guide-line' of https://github.com/lnash94/ballerina…

0ddbc75

…-dev-website into add-guide-line

anuruddhal reviewed Feb 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[master]Add Ballerina Deployment Guide #9660

[master]Add Ballerina Deployment Guide #9660

lnash94 commented Jan 3, 2025 •

edited

Loading

shafreenAnfar commented Jan 22, 2025

lnash94 commented Jan 24, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025 •

edited

Loading

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage Feb 4, 2025

anupama-pathirage commented Feb 4, 2025

anuruddhal Feb 6, 2025 •

edited

Loading

anuruddhal Feb 6, 2025


		Use the `bal build` command to build the Ballerina package. This will generate Kubernetes YAML files and Docker container artifacts.

		>Note: For macOS users with Apple Silicon chips, it is necessary to set the environment variable DOCKER_DEFAULT_PLATFORM to linux/amd64 before building the image. This requirement exists because the Ballerina Docker image does not currently support Apple Silicon chips.

	2. Install the Ballerina distribution from [the Ballerina Installation options.](https://ballerina.io/downloads/)
	2. Install [Ballerina](https://ballerina.io/downloads/).

	- Execute the curl http://192.168.49.2:30342/helloWorld/greeting command to access the deployed service via cURL.
	- Execute the following command to access the deployed service via cURL.

	3. Use `bal build` for generating the AWS Lambda artifacts.
	3. Use `bal build` to generate the AWS Lambda artifacts.


		1. Set up the prerequisites by following [these instructions.](https://ballerina.io/learn/azure-functions/#set-up-the-prerequisites)

		2. Here is an example Ballerina code.

	2. Here is an example Ballerina code.
	2. Here is an sample Ballerina code.

[master]Add Ballerina Deployment Guide #9660

Are you sure you want to change the base?

[master]Add Ballerina Deployment Guide #9660

Conversation

lnash94 commented Jan 3, 2025 • edited Loading

Purpose

Checklist

shafreenAnfar commented Jan 22, 2025

lnash94 commented Jan 24, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anupama-pathirage Feb 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anupama-pathirage commented Feb 4, 2025

anuruddhal Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lnash94 commented Jan 3, 2025 •

edited

Loading

anupama-pathirage Feb 4, 2025 •

edited

Loading

anuruddhal Feb 6, 2025 •

edited

Loading