Skip to content

Docs tweaks - cloud sizes #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabriciojs merged 2 commits into from
Feb 12, 2024
Merged

Docs tweaks - cloud sizes #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db3d128
add link to official docker build docs
fabriciojs Feb 11, 2024
64bb6ba
tweak cloud docs - add sizes reference
fabriciojs Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/02-Kool-Cloud/01-Getting-Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
The [Kool.dev Cloud](https://kool.dev/cloud) supports a wide range of features designed to suit your needs for deploying containerized web applications. It includes features such as **persisting folders** across deployments, running **daemons** as extra containers, scheduling commands like **cron jobs**, adding **hooks to run before or after** deployment, **viewing logs** of running containers, accessing the running container **interactively**, and much more.
# About Kool.dev Cloud

The [Kool.dev Cloud](https://kool.dev/cloud) brings the ease you always thought should exist when deploying web applications running in containers to the cloud.

For developers stepping into the world of cloud-native development, **Kool.dev** is a game-changer. It bridges the gap between the **complexity of container management** and the efficiency of cloud-native applications, empowering developers to focus more on creating value and less on managing infrastructure.

The Kool.dev Cloud API was designed with the best developer experience in mind for deploying containers to the cloud. By leveraging your existing local environment structure in `docker-compose.yml` and adding a sane and intuitive configuration layer that will feel familiar from the first sight, our goal is to provide a best-in-class offering for cloud platform engineering. This platform allows you to leverage Kubernetes and orchestrate your web applications in the cloud without all the hassle.

> **Enterprise**: You can use Kool.dev Cloud to deploy workloads to your own cloud vendor to keep things compliant - [contact us](mailto:contact@kool.dev) for the **"Bring your Own Cloud"** offer.

**Kool.dev Cloud** is the CLI suite of commands that allows you to configure, deploy, access, and tail logs from the applications to the cloud via the Kool.dev Cloud API.

## Deploy Docker Compose-based, containerized apps in just a few simple steps
# Features

## CPU and Memory Resources

Having your application in a container helps isolating its resources and allocate them more efficiently, while scaling up and down seamlessly.

Currently the sizing of containers go by a simple scale: `micro`, `small`, `medium`, `large`, `xlarge`, `xxlarge`. The `micro` size starts with **128 millicores** of CPU and **256Mbi** of memory limits. Each size then doubles the previous size limits.

## Persistent Storage

Kool.dev Cloud supports **persisting folders** across deployments. This is a key piece that facilitates moving legacy applications into containers.

## More that you may need

Supporting a wide range of features you will find no limits on any requirements your web application might have. Running **daemons** as extra containers, scheduling commands like **cron jobs**, adding **hooks to run before or after** deployment, **viewing logs** of running containers, accessing the running container **interactively**, and much more.

# Getting Started Steps

1. [Sign up for Kool.dev Cloud](https://kool.dev/register) and get your access token.
- You can store your token in your `.env` file if you are using one:
Expand Down
2 changes: 1 addition & 1 deletion docs/25-Upgrade-Guide/0-Upgrading-Kool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ It is recommended to rename your configuration file for **Kool.dev Cloud** from

Version 3.x introduces two significant changes:

- The YAML syntax for `services.<service>.build` in the `kool.cloud.yml` file must now align with the official Docker Compose reference for the `service.<service>.build` entry.
- The YAML syntax for `services.<service>.build` in the `kool.cloud.yml` configuration file must now align with the official [Docker Compose reference for the `service.<service>.build`](https://docs.docker.com/compose/compose-file/compose-file-v3/#build) entry.
- Image building now occurs in your local environment—specifically, on the host where you execute `kool cloud deploy`. Therefore, ensure that the environment from which you run this command has a properly configured Docker-image build engine (that means Kool to be able to run `docker build` command).

### Github Action `kool-dev/action`
Expand Down