Configure Advanced Settings for DigitalOcean Managed Databases

This project is a web application built with React and React Router that provides a user interface for configuring advanced settings on DigitalOcean Managed Databases. The tool allows you to customize configuration options for various database engines (MySQL, PostgreSQL, Redis, MongoDB, Kafka, OpenSearch) and then generates API requests (including preformatted curl and doctl commands) so you can update your databases via DigitalOcean's API.

Deploy Your Own Instance

You can deploy your own instance of this application to DigitalOcean App Platform with just a few clicks using the button below:

The deployment will automatically configure everything needed to run the application, including building from source and setting up the web service.

Usage

When you open the application in your browser, you will see a multi-section interface:

Database ID Input:
An input field where you provide your database's unique ID. (You can get your database ID by using the doctl databases list command.)
Configuration Forms:
A tabbed interface lets you choose which database engine's settings you'd like to adjust (MySQL, PostgreSQL, Redis, MongoDB, Kafka, or OpenSearch). Each tab displays relevant fields along with details (range, expected input format, examples).
Command Generation:
Once you fill out the settings, the tool generates preformatted curl and doctl commands based on your inputs. Click the "Copy" button to copy the command to your clipboard.
API Request:
When you submit your configuration changes, the app generates the correct API request so you can update your managed database settings.

GitHub Workflows

This project uses several GitHub Actions workflows to automate deployment and monitoring:

Deployment Workflows

App Platform - Deployment (deploy-app.yml):
Automatically deploys the application to DigitalOcean App Platform when changes are pushed to the main branch.
App Platform - Preview (deploy-pull-preview.yml):
Creates preview deployments for pull requests, allowing you to test changes before merging. The workflow posts the preview URL as a comment on the PR.
App Platform - Delete Preview (delete-pull-preview.yml):
Automatically cleans up preview deployments when pull requests are closed.

Monitoring Workflow

Monitor DO OpenAPI Database Changes (do-openapi.yml):
- Runs periodically to check for updates to DigitalOcean's OpenAPI specification
- Monitors changes specifically in the database configuration models
- Creates a pull request when changes are detected
- Includes commit details and links to the original OpenAPI changes
- Helps maintain compatibility with DigitalOcean's latest API updates

Local Development

To run this application locally:

Clone the repository
Install dependencies:
```
npm install
```
Start the development server:
```
npm run dev
```
Open http://localhost:5173 in your browser

Contributing

We welcome contributions to improve the DO Database Config UI! Here's how you can help:

Project Structure

The main application code is located in src/artifacts/index.tsx. The project follows a component-based architecture using React and TypeScript.

How to Contribute

Fork the repository

Create a new branch for your feature:

git checkout -b feature/your-feature-name

Make your changes
Commit your changes:
```
git commit -m "Add your commit message"
```

Push to your fork:

git push origin feature/your-feature-name

Open a Pull Request

jkpe/do-db-config-ui