Skip to content

Commit 7873169

Browse files
Merge pull request #1852 from chathuraHarshanga/PE
changing build packs with build presets
2 parents 8789c36 + b349ae9 commit 7873169

File tree

45 files changed

+92
-92
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+92
-92
lines changed

en/.spelling

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ DockerHub
1010
Quickstart
1111
Entra
1212
AzureAD
13-
buildpack
14-
buildpacks
13+
build preset
14+
build presets
1515
Temurin
1616
RabbitMQ
1717
SalesOrderQueue

en/developer-docs/docs/authentication-and-authorization/secure-web-applications-with-managed-authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ As a developer, you can easily set up Choreo's managed authentication to seamles
77
Choreo's managed authentication follows the backend for frontend (BFF) architecture, which is a secure pattern recommended for browser-based applications that utilize OIDC/OAuth2.0 for authentication and authorization. This architecture ensures that OAuth tokens remain secure from browser-side code, making them immune to potential attacks like cross-site scripting (XSS).
88

99
!!! note
10-
Choreo's managed authentication is currently available only for web applications created with **React**, **Angular**, or **Vue.js** buildpacks.
10+
Choreo's managed authentication is currently available only for web applications created with **React**, **Angular**, or **Vue.js** build presets.
1111

1212
!!! warning
1313
Managed authentication uses the 'SAMESITE' cookie attribute to prevent CSRF attacks. Therefore, it is recommended to use managed authentication with modern browsers that support the 'SAMESITE' attribute.
@@ -172,7 +172,7 @@ To ensure that your web application functions seamlessly with managed authentica
172172
You can enable managed authentication for your web application component at the time you deploy the component.
173173

174174
!!! tip
175-
Managed authentication is enabled by default when you create a web application using **React**, **Angular**, or **Vue.js** buildpacks.
175+
Managed authentication is enabled by default when you create a web application using **React**, **Angular**, or **Vue.js** build presets.
176176

177177
1. Sign in to the [Choreo Console](https://console.choreo.dev/). This opens the project home page.
178178
2. In the **Component Listing** pane, click on the web application for which you want to enable managed authentication.

en/developer-docs/docs/choreo-cli/get-started-with-the-choreo-cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ This triggers a wizard prompting you to provide details for your Git repository
8888
| Port | `8080` |
8989

9090
!!! note
91-
The prompts may vary based on the type of component and the chosen build pack.
91+
The prompts may vary based on the type of component and the chosen build preset.
9292

9393

9494
## Step 4: View component details

en/developer-docs/docs/choreo-concepts/ci-cd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Choreo auto-generates build pipelines that may slightly differ depending on the
2424
- Pushes the container image to a container registry. In the cloud data plane, Choreo pushes the image to a Choreo-managed registry. If it is a private data plane organization, Choreo pushes the image to a registry that you own.
2525
- Updates service endpoints and API specifications from the provided repository if applicable.
2626

27-
In addition to these steps, some buildpacks support integrating unit tests into the build pipeline. For more details, see [Integrate Unit Tests into the Build Pipeline](../develop-components/integrate-unit-tests-into-the-build-pipeline.md).
27+
In addition to these steps, some build presets support integrating unit tests into the build pipeline. For more details, see [Integrate Unit Tests into the Build Pipeline](../develop-components/integrate-unit-tests-into-the-build-pipeline.md).
2828

2929
### Repeatable builds
3030

en/developer-docs/docs/choreo-samples/samples-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To view available samples, follow these steps:
2929

3030
When you view all samples, you can filter and search for samples by the following criteria:
3131

32-
- **Buildpack**: Filters by the technology used. For example, Ballerina, NodeJS, Docker, etc.
32+
- **Build preset**: Filters by the technology used. For example, Ballerina, NodeJS, Docker, etc.
3333
- **Component Type**: Filters by the component type. For example, service, web application, scheduled tasks, manual tasks, etc.
3434
- **Tags**: Use tags like REST, HTTP, or GraphQL to find samples with specific functionalities or integrations.
3535

en/developer-docs/docs/develop-components/configure-endpoints-body.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Choreo defines endpoints by combining port binding, protocol, endpoint name, net
1313
| Context (HTTP and GraphQL only) | A context path that you add to the endpoint's URL for routing purposes. |
1414

1515
## Configure endpoints
16-
The method of defining endpoints depends on the buildpack.
16+
The method of defining endpoints depends on the build preset.
1717

18-
* For `Ballerina` and `WSO2 MI` buildpacks, Choreo automatically detects the endpoint details for REST APIs.
19-
* For all other buildpacks (Java, Python, NodeJS, Ruby, PHP, Go, Dockerfile, etc.), you can configure endpoints in one of the following ways:
18+
* For `Ballerina` and `WSO2 MI` build presets, Choreo automatically detects the endpoint details for REST APIs.
19+
* For all other build presets (Java, Python, NodeJS, Ruby, PHP, Go, Dockerfile, etc.), you can configure endpoints in one of the following ways:
2020

2121
* **Using the Choreo Console**: If a `component.yaml` file is not present, you can define a basic endpoint configuration during component creation.
2222
* **Using the component.yaml file**: You can manually configure endpoint details by defining them in a `component.yaml` file, placing it inside the `.choreo` directory at the build context path, and committing it to the source repository.

en/developer-docs/docs/develop-components/deploy-a-containerized-application.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Alternatively, you can connect a public repository without requiring authorizati
4242
Authorizing the repository with the [Choreo Apps](https://github.com/marketplace/choreo-apps) GitHub application becomes essential if you want to enable [**Auto Deploy**](https://wso2.com/choreo/docs/choreo-concepts/ci-cd/#deploy) for the component. If you own the repository, you can subsequently authorize it with the [Choreo Apps](https://github.com/marketplace/choreo-apps) GitHub application to enable **Auto Deploy**.
4343

4444
After granting access to the required repositories, you can choose a repository and an associated branch to connect to the Choreo component.
45-
For the containerized application deployments, you should select the [**Component Directory**](https://docs.docker.com/build/building/context/#path-context), **Dockerfile** as the **Buildpack** and provide **Dockerfile Path** for the Docker build.
45+
For the containerized application deployments, you should select the [**Component Directory**](https://docs.docker.com/build/building/context/#path-context), **Dockerfile** as the **Build preset** and provide **Dockerfile Path** for the Docker build.
4646

4747
![Connected Dockerfile Repository](../assets/img/develop-components/deploy/create-component-connected-repo.png){.cInlineImage-full}
4848

@@ -53,7 +53,7 @@ The following table describes the individual fields in the **Create Component**
5353
| **GitHub Account** | Your GitHub account or organization. If you want to add another GitHub account, you can expand the list and click **+ Add**. |
5454
| **GitHub Repository** | Depending on the repository access you provided, the list will show available repositories to be connected. |
5555
| **Branch** | The branch of the repository. |
56-
| **Buildpack** | Determines the implementation of the component: Any language or other language as a Docker container. |
56+
| **Build preset** | Determines the implementation of the component: Any language or other language as a Docker container. |
5757
| **Dockerfile Path** | The path to your Dockerfile. This path is defined relative to the repository root.<br/>For example, if the Dockerfile is at the repository root, the value for this field is `/Dockerfile`. |
5858
| **Component Directory** | The component directory path. To include the repository root, leave the default `/` value. |
5959
| **Port*** | The port at which your service is running. |

en/developer-docs/docs/develop-components/deploy-an-application-with-buildpacks.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Deploy an Application with Buildpacks
1+
# Deploy an Application with Build Presets
22

33
Using Choreo, you can easily deploy applications written in different language frameworks (such as Java, Go, NodeJS, Python, Ruby, PHP, etc.) on shared or private data planes.
44

5-
Choreo supports deploying applications with buildpacks for the following component types:
5+
Choreo supports deploying applications with build presets for the following component types:
66

77
- Service
88
- Web Application
@@ -12,10 +12,10 @@ Choreo supports deploying applications with buildpacks for the following compone
1212
- Event Handler
1313
- Test Runner
1414

15-
## Buildpacks
16-
Buildpacks are a fundamental building block in modern application development. They convert your source code into a secure, efficient, production-ready container image without a Dockerfile. With Choreo, developers can take advantage of this powerful tool to effortlessly deploy their applications without the hassle of manual configuration.
15+
## Build Presets
16+
Build presets are a fundamental building block in modern application development. They convert your source code into a secure, efficient, production-ready container image without a Dockerfile. With Choreo, developers can take advantage of this powerful tool to effortlessly deploy their applications without the hassle of manual configuration.
1717

18-
Choreo uses [Google Buildpacks](https://cloud.google.com/docs/buildpacks/overview) as default buildpacks for Java, Go, NodeJS, Python, PHP, and Ruby. Choreo uses its own buildpacks for Ballerina and WSO2 MI.
18+
Choreo uses [Google Buildpacks](https://cloud.google.com/docs/buildpacks/overview) as default build presets for Java, Go, NodeJS, Python, PHP, and Ruby. Choreo uses its own build presets for Ballerina and WSO2 MI.
1919

2020
## Develop a component
2121

@@ -159,25 +159,25 @@ Follow the guidelines below based on your language:
159159
- 8, 11, 17, 18 (OpenJDK Runtime Environment Temurin)
160160

161161
!!! info
162-
You can use this buildpack only with web applications. For other component types, use the **Java** buildpack. Additionally, if the generated artifact is a `WAR` file, you must include the run command in the **Build Configurations** editor on the component's **Build** page. <br> e.g.,
162+
You can use this build preset only with web applications. For other component types, use the **Java** build preset. Additionally, if the generated artifact is a `WAR` file, you must include the run command in the **Build Configurations** editor on the component's **Build** page. <br> e.g.,
163163
`java -jar target/sample.war` <br>
164164

165165
### Configure build-time environment variables
166166

167167
You can configure the environment variables necessary to build the component using the **Build Configurations Editor** on the component **Build** page.
168168

169169
!!! info
170-
The capability to configure build-time environment variables is not available for components created using **Ballerina** or **WSO2 MI** buildpacks.
170+
The capability to configure build-time environment variables is not available for components created using **Ballerina** or **WSO2 MI** build presets.
171171

172-
During the build process, the build-time environment variables and their values are passed to the buildpack. Therefore, you can configure both buildpack-specific environment variables and those required for the component build.
172+
During the build process, the build-time environment variables and their values are passed to the build preset. Therefore, you can configure both build preset-specific environment variables and those required for the component build.
173173

174-
For example, if you want to override the Maven command of the **Java** buildpack, you can use `GOOGLE_MAVEN_BUILD_ARGS` as the environment key and `clean install` as the value.
174+
For example, if you want to override the Maven command of the **Java** build presets, you can use `GOOGLE_MAVEN_BUILD_ARGS` as the environment key and `clean install` as the value.
175175

176176
For more examples, see [Google Cloud's buildpacks documentation](https://cloud.google.com/docs/buildpacks/service-specific-configs).
177177

178178
### Customize the Default Run Command
179179

180-
You can configure the run command required to start the component via the **Build Configurations** editor on the component's **Build** page. This overrides the default run command provided by the buildpack. After configuring the run command, you must rebuild the component for the changes to take effect.<br>
180+
You can configure the run command required to start the component via the **Build Configurations** editor on the component's **Build** page. This overrides the default run command provided by the build preset. After configuring the run command, you must rebuild the component for the changes to take effect.<br>
181181

182182
e.g., <br>
183183

en/developer-docs/docs/develop-components/deploy-mcp-servers/deploy-a-mcp-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Choreo allows you to create and deploy MCP Server applications in Python and Nod
44

55
In this guide, you will:
66

7-
- Deploy an stdio-based [github-mcp-server](https://github.com/github/github-mcp-server) in Choreo over SSE (Server-Sent Events) using a `NodeJs` buildpack.
7+
- Deploy an stdio-based [github-mcp-server](https://github.com/github/github-mcp-server) in Choreo over SSE (Server-Sent Events) using a `NodeJs` build preset.
88

99
## Prerequisites
1010

@@ -33,7 +33,7 @@ To create a mcp server component, follow these steps:
3333
| **Server Package** | @modelcontextprotocol/server-github |
3434
| **Run Command** | npx -y @modelcontextprotocol/server-github |
3535

36-
6. Select **NodeJs** as the buildpack.
36+
6. Select **NodeJs** as the build preset.
3737
7. Provide component display name, name and description:
3838

3939
!!! info

en/developer-docs/docs/develop-components/develop-a-webhook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To create a Webhook component, follow these steps:
4949
| **Branch** | main |
5050
| **Component Path** | `github-event-to-email-webhook` |
5151

52-
6. Select **Ballerina** as the build pack.
52+
6. Select **Ballerina** as the build preset.
5353
7. Provide a display name, a unique name and description for the component.
5454
8. Click **Create**.
5555

@@ -95,7 +95,7 @@ To allow the webhook to read the labels of issues in a specific GitHub repositor
9595
| **Secret** | The last webhook secret you configured in [Step 2](#step-2-deploy).|
9696

9797
!!! tip
98-
- **Buildpack** specifies the type of build to run depending on the implementation of the component. It converts the integration code into a Docker image that can run on Choreo cloud. If an integration is developed using [WSO2 Integration Studio](https://wso2.com/integration/integration-studio/), select **Micro Integrator** as the buildpack. If an integration is developed using the [Ballerina language](https://ballerina.io), select **Ballerina** as the buildpack.
98+
- **Build preset** specifies the type of build to run depending on the implementation of the component. It converts the integration code into a Docker image that can run on Choreo cloud. If an integration is developed using [WSO2 Integration Studio](https://wso2.com/integration/integration-studio/), select **Micro Integrator** as the build preset. If an integration is developed using the [Ballerina language](https://ballerina.io), select **Ballerina** as the build preset.
9999
- **Project Path** specifies the location of the project to build the component.
100100

101101
7. Under **Which events would you like to trigger this webhook?**, select **Let me select individual events**.

0 commit comments

Comments
 (0)