Frappe Kubernetes Automation

This documentation outlines the functionalities and APIs provided by the Frappe Kubernetes automation system.

1. Install Custom App

2. Workspace Kubernetes Configuration

Navigate to the Kubernetes Config Doctype to upload the cluster file and Docker account credentials.

4. Create App

Create apps and save their Git branch and URL, which are useful for creating Docker images.

5. Docker Image

• Create a new Docker image with selected apps.
• After saving the Docker image, click on the Create Image button. This will create the Docker image if it's not created before. The status of the Docker image will update to Live after a while, indicating successful creation.
• If is_current is checked, that image will be fetched automatically during the creation of a site.

6. Create Site

The Site Creation Details Doctype is used to create, delete, or update the site creation log. This doctype includes create_site, update_log, and delete_site buttons, responsible for managing site logs.

7. API Authentication

To authenticate API requests, use the api.apis.get_api_auth_token API. Provide Frappe site credentials in JSON format ({'username':'', 'password':''}). Include the token returned in the authentication header for all subsequent API requests.

8. APIs List

api.apis.create_site

• Input: JSON object

  {
      "site_name": "",
      "password": "",
      "image_url": "" // Docker image URL
  }
  

api.apis.update_job_status

• Input: JSON object

  {
      "site_job_name":"all" or "job-name"
  }
  
  

api.apis.site_detail_list

• Input: JSON object

  {
      "site_job_name":"all" or "job-name"
  }
  
  

api.apis.delete_site

• Input: JSON object

  {
      "site_name":"",
      "password":""
  }
  

api.apis.create_docker_image