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:
docker version
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:
kubectl config use-context docker-desktop
Switched to context "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.
kubectl get node
NAME STATUS ROLES AGE VERSIONdocker-desktop Ready control-plane 37m v1.30.2
Run the following command on macOS with HomeBrew installed:
brew install orbstack
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:
kubectl config use-context orbstack
Switched to context "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.
kubectl get node
NAME STATUS ROLES AGE VERSIONorbstack Ready control-plane,master 7m14s v1.29.3+orb1
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:
2. Run the following command to ensure kubectl commands are applied to the K8s cluster created by kind:
kubectl config use-context kind
Switched to context "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.
kubectl get node
NAME STATUS ROLES AGE VERSIONkind-control-plane Ready control-plane 19m v1.31.2kind-worker Ready <none> 19m v1.31.2kind-worker2 Ready <none> 19m v1.31.2
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 App to create your APP:
Read and Write
Actions
Administration
Commit statuses
Contents
Deployments
Issues
Pull requests
Workflows
Read-only
Metadata
Read and Write
Administration
Read-only
Members
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 secret to create and view the Client Secret.
2-3. Private Key
Click Generate a private key at the bottom of the screen to download the pem file.
3. Integrate GitHub App in ale
Enter http://localhost:9001 in 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 click Apply.
On the dashboard, click or ⌘ + K to open the deployment modal, then select the HTTPBin template.
Without changing any settings, click Deploy at 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.
