Quick Start
Guide for installing ale locally and deploying an application to a local K8s cluster.
Node.js version 20 or higher is required to use ale.
Cluster Setup
Docker Desktop
Docker Desktop
- Visit the Docker Desktop website and download the installation file that matches your OS and architecture. After completing the installation, verify that Docker was installed correctly by entering the following command in your terminal:
Setting up the Kubernetes Cluster
1. Open Docker Desktop settings, select Kubernetes from the left menu.
Check Enable Kubernetes and click Apply & restart at the bottom.
2. Run the following command to ensure kubectl commands are applied to the Kubernetes cluster created by Docker Desktop:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and Docker Desktop status.
OrbStack
OrbStack
- Run the following command on macOS with HomeBrew installed:
Setting up the Kubernetes Cluster
1. Open OrbStack settings and select the Kubernetes tab.
Check both Enable Kubernetes cluster and Expose services to local network devices, then click Apply at the bottom.
2. Run the following command to ensure kubectl commands are applied to the Kubernetes cluster created by OrbStack:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and OrbStack status.
kind
kind
kind requires go version 1.16 or higher to be installed. Download and install the appropriate file for your operating system from this page, then run the following command to add go to your shell’s PATH:
- Run the following command in your terminal:
Setting up the Kubernetes Cluster
1. Enter the following command in your terminal:
2. Run the following command to ensure kubectl commands are applied to the K8s cluster created by kind:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and the status of running containers.
Install and Run ale
Enter the following commands to install the `ale-run` package:
Run the following commands to install the Nginx Ingress Controller:
Run the following command to install the Metrics Server:
Enter the following command to run ale in development mode:
Select the cluster where you want to deploy services using ale. The cluster list is retrieved from the contexts registered in `~/.kube/config`.
When you see logs like the following, the setup is complete:
If you encounter database conflicts during execution, delete existing ale data using the following command and restart:
By integrating your local environment with GitHub, you can deploy source code from GitHub repositories.
GitHub Integration for Local Environment
GitHub Integration for Local Environment
1. Create GitHub Apps
After logging into GitHub, go to Settings > Developer Settings > GitHub Apps and click New GitHub App.
1-1. Provide Basic Information
Enter the following information to create your GitHub App:
- GitHub App name: Name for your GitHub App
- Homepage URL
- URL where GitHub OAuth will be applied
- Local access address:
http://localhost:9001
- Callback URL (Add with
Add Callback URL)http://localhost:9009/oauth/github/callbackhttp://localhost:9009/oauth/github/connect/callback
The GitHub App name entered here will be used when registering GitHub OAuth with ale.
Since this is a local environment, use http instead of https, and localhost:9009 is ale’s API endpoint address.
1-2. Disable Webhook
Uncheck Active in the Webhook section to disable it.
1-3. Grant Permissions and Create APP
Grant the following permissions in the Permission section and click
Create GitHub Appto create your APP:
Repository permissions (9)
Repository permissions (9)
- Read and Write
- Actions
- Administration
- Commit statuses
- Contents
- Deployments
- Issues
- Pull requests
- Workflows
- Read-only
- Metadata
Organization permissions (2)
Organization permissions (2)
- Read and Write
- Administration
- Read-only
- Members
Account permissions (1)
Account permissions (1)
- Read-only
- Email addresses
2. Get GitHub App Information
To add GitHub OAuth to
ale, you’ll need 4 ID/Key values in addition to the GitHub App Name:
- App ID
- Client ID
- Client Secret
- Private Key
2-1. App ID and Client ID
After creating the App with the granted permissions, you can view the App ID and Client ID.
2-2. Client Secret
On the same screen, click
Generate a new client secretto create and view the Client Secret.
2-3. Private Key
Click
Generate a private keyat the bottom of the screen to download the pem file.
3. Integrate GitHub App in ale
Enter
http://localhost:9001in your browser’s address bar to access the operation system, then go to Settings > Authentication > GitHub dropdown. Enter the values obtained from the previous steps into each field and clickApply.
- APP_NAME: GitHub App name
- APP_ID: App ID
- CLIENT_ID: Client ID
- CLIENT_SECRET: Client secret
- APP_PRIVATE_KEY: Private key pem file value
Access Dashboard
Go to
http://localhost:9001. On first access, you’ll be connected to the default@devspace.
Accessing the operations system
Accessing the operations system
You can access the operation system by clicking the space name in the top left of the dashboard and selecting the operation system.
Deploy
On the dashboard, click or
⌘ + Kto open the deployment modal, then select the HTTPBin template.
Without changing any settings, click
Deployat the bottom.
Once deployment is complete, you can access the preview page.
You can deploy GitHub repositories by integrating your local environment with GitHub or deploy private repositories using SSH authentication. For general deployment with ale, refer to the Deploying with ale page.
Quick Start
Guide for installing ale locally and deploying an application to a local K8s cluster.
Node.js version 20 or higher is required to use ale.
Cluster Setup
Docker Desktop
Docker Desktop
- Visit the Docker Desktop website and download the installation file that matches your OS and architecture. After completing the installation, verify that Docker was installed correctly by entering the following command in your terminal:
Setting up the Kubernetes Cluster
1. Open Docker Desktop settings, select Kubernetes from the left menu.
Check Enable Kubernetes and click Apply & restart at the bottom.
2. Run the following command to ensure kubectl commands are applied to the Kubernetes cluster created by Docker Desktop:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and Docker Desktop status.
OrbStack
OrbStack
- Run the following command on macOS with HomeBrew installed:
Setting up the Kubernetes Cluster
1. Open OrbStack settings and select the Kubernetes tab.
Check both Enable Kubernetes cluster and Expose services to local network devices, then click Apply at the bottom.
2. Run the following command to ensure kubectl commands are applied to the Kubernetes cluster created by OrbStack:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and OrbStack status.
kind
kind
kind requires go version 1.16 or higher to be installed. Download and install the appropriate file for your operating system from this page, then run the following command to add go to your shell’s PATH:
- Run the following command in your terminal:
Setting up the Kubernetes Cluster
1. Enter the following command in your terminal:
2. Run the following command to ensure kubectl commands are applied to the K8s cluster created by kind:
3. Run the following command in your terminal to verify that the cluster is running properly. If the STATUS is not Ready or if the output below is not displayed, the Kubernetes cluster is not available for use, and you should check the context and the status of running containers.
Install and Run ale
Enter the following commands to install the `ale-run` package:
Run the following commands to install the Nginx Ingress Controller:
Run the following command to install the Metrics Server:
Enter the following command to run ale in development mode:
Select the cluster where you want to deploy services using ale. The cluster list is retrieved from the contexts registered in `~/.kube/config`.
When you see logs like the following, the setup is complete:
If you encounter database conflicts during execution, delete existing ale data using the following command and restart:
By integrating your local environment with GitHub, you can deploy source code from GitHub repositories.
GitHub Integration for Local Environment
GitHub Integration for Local Environment
1. Create GitHub Apps
After logging into GitHub, go to Settings > Developer Settings > GitHub Apps and click New GitHub App.
1-1. Provide Basic Information
Enter the following information to create your GitHub App:
- GitHub App name: Name for your GitHub App
- Homepage URL
- URL where GitHub OAuth will be applied
- Local access address:
http://localhost:9001
- Callback URL (Add with
Add Callback URL)http://localhost:9009/oauth/github/callbackhttp://localhost:9009/oauth/github/connect/callback
The GitHub App name entered here will be used when registering GitHub OAuth with ale.
Since this is a local environment, use http instead of https, and localhost:9009 is ale’s API endpoint address.
1-2. Disable Webhook
Uncheck Active in the Webhook section to disable it.
1-3. Grant Permissions and Create APP
Grant the following permissions in the Permission section and click
Create GitHub Appto create your APP:
Repository permissions (9)
Repository permissions (9)
- Read and Write
- Actions
- Administration
- Commit statuses
- Contents
- Deployments
- Issues
- Pull requests
- Workflows
- Read-only
- Metadata
Organization permissions (2)
Organization permissions (2)
- Read and Write
- Administration
- Read-only
- Members
Account permissions (1)
Account permissions (1)
- Read-only
- Email addresses
2. Get GitHub App Information
To add GitHub OAuth to
ale, you’ll need 4 ID/Key values in addition to the GitHub App Name:
- App ID
- Client ID
- Client Secret
- Private Key
2-1. App ID and Client ID
After creating the App with the granted permissions, you can view the App ID and Client ID.
2-2. Client Secret
On the same screen, click
Generate a new client secretto create and view the Client Secret.
2-3. Private Key
Click
Generate a private keyat the bottom of the screen to download the pem file.
3. Integrate GitHub App in ale
Enter
http://localhost:9001in your browser’s address bar to access the operation system, then go to Settings > Authentication > GitHub dropdown. Enter the values obtained from the previous steps into each field and clickApply.
- APP_NAME: GitHub App name
- APP_ID: App ID
- CLIENT_ID: Client ID
- CLIENT_SECRET: Client secret
- APP_PRIVATE_KEY: Private key pem file value
Access Dashboard
Go to
http://localhost:9001. On first access, you’ll be connected to the default@devspace.
Accessing the operations system
Accessing the operations system
You can access the operation system by clicking the space name in the top left of the dashboard and selecting the operation system.
Deploy
On the dashboard, click or
⌘ + Kto open the deployment modal, then select the HTTPBin template.
Without changing any settings, click
Deployat the bottom.
Once deployment is complete, you can access the preview page.
You can deploy GitHub repositories by integrating your local environment with GitHub or deploy private repositories using SSH authentication. For general deployment with ale, refer to the Deploying with ale page.