Skip to content

Commit

Permalink
standardize kool.dev cloud naming
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriciojs committed Jan 9, 2024
1 parent 0b8951d commit c18c3cf
Show file tree
Hide file tree
Showing 19 changed files with 48 additions and 48 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

**Kool** is a CLI tool that brings the complexities of modern software development environments down to earth - making these environments lightweight, fast and reproducible. It reduces the complexity and learning curve of _Docker_ containers for local environments, and offers a simplified interface for using _Kubernetes_ to deploy staging and production environments to the cloud.

**Kool** gets your local development environment up and running easily and quickly, so you have more time to build a great application. When the time is right, you can then use Kool Cloud to deploy and share your work with the world!
**Kool** gets your local development environment up and running easily and quickly, so you have more time to build a great application. When the time is right, you can then use Kool.dev Cloud to deploy and share your work with the world!

**Kool** is suitable for solo developers and teams of all sizes. It provides a hassle-free way to handle the Docker basics and immediately start using containers for development, while simultaneously guaranteeing no loss of control over more specialized Docker environments.

Expand Down
8 changes: 4 additions & 4 deletions commands/cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ func AddKoolCloud(root *cobra.Command) {
func NewCloudCommand(cloud *Cloud) (cloudCmd *cobra.Command) {
cloudCmd = &cobra.Command{
Use: "cloud COMMAND [flags]",
Short: "Interact with Kool Cloud and manage your deployments.",
Long: "The cloud subcommand encapsulates a set of APIs to interact with Kool Cloud and deploy, access and tail logs from your deployments.",
Short: "Interact with Kool.dev Cloud and manage your deployments.",
Long: "The cloud subcommand encapsulates a set of APIs to interact with Kool.dev Cloud and deploy, access and tail logs from your deployments.",
Example: `kool cloud deploy`,
// add cobra usage help content
DisableFlagsInUseLine: true,
Expand Down Expand Up @@ -85,7 +85,7 @@ func NewCloudCommand(cloud *Cloud) (cloudCmd *cobra.Command) {
// if no token is set, we try to get it from the environment
if cloud.flags.Token == "" && cloud.env.Get("KOOL_API_TOKEN") == "" {
if requiredFlags {
err = fmt.Errorf("missing Kool Cloud API token - please set it via --token or KOOL_API_TOKEN environment variable")
err = fmt.Errorf("missing Kool.dev Cloud API token - please set it via --token or KOOL_API_TOKEN environment variable")

Check warning on line 88 in commands/cloud.go

View check run for this annotation

Codecov / codecov/patch

commands/cloud.go#L88

Added line #L88 was not covered by tests
return
}
} else if cloud.flags.Token != "" {
Expand All @@ -96,7 +96,7 @@ func NewCloudCommand(cloud *Cloud) (cloudCmd *cobra.Command) {
},
}

cloudCmd.PersistentFlags().StringVarP(&cloud.flags.Token, "token", "", "", "Token to authenticate with Kool Cloud API")
cloudCmd.PersistentFlags().StringVarP(&cloud.flags.Token, "token", "", "", "Token to authenticate with Kool.dev Cloud API")
cloudCmd.PersistentFlags().StringVarP(&cloud.flags.DeployDomain, "domain", "", "", "Environment domain name to deploy to")

return
Expand Down
2 changes: 1 addition & 1 deletion commands/cloud_deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ type KoolDeploy struct {
func NewDeployCommand(deploy *KoolDeploy) (cmd *cobra.Command) {
cmd = &cobra.Command{
Use: "deploy",
Short: "Deploy a local application to a Kool Cloud environment",
Short: "Deploy a local application to a Kool.dev Cloud environment",
RunE: DefaultCommandRunFunction(deploy),
Args: cobra.NoArgs,

Expand Down
2 changes: 1 addition & 1 deletion commands/cloud_deploy_destroy.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type KoolDeployDestroy struct {
func NewDeployDestroyCommand(destroy *KoolDeployDestroy) *cobra.Command {
return &cobra.Command{
Use: "destroy",
Short: "Destroy an environment deployed to Kool Cloud",
Short: "Destroy an environment deployed to Kool.dev Cloud",
Args: cobra.NoArgs,
RunE: DefaultCommandRunFunction(destroy),

Expand Down
4 changes: 2 additions & 2 deletions commands/cloud_deploy_exec.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ type KoolDeployExecFlags struct {
func NewDeployExecCommand(deployExec *KoolDeployExec) (cmd *cobra.Command) {
cmd = &cobra.Command{
Use: "exec SERVICE [COMMAND] [--] [ARG...]",
Short: "Execute a command inside a running service container deployed to Kool Cloud",
Long: `After deploying an application to Kool Cloud using 'kool deploy',
Short: "Execute a command inside a running service container deployed to Kool.dev Cloud",
Long: `After deploying an application to Kool.dev Cloud using 'kool deploy',
execute a COMMAND inside the specified SERVICE container (similar to an SSH session).
Must use a KOOL_API_TOKEN environment variable for authentication.`,
Args: cobra.MinimumNArgs(1),
Expand Down
4 changes: 2 additions & 2 deletions commands/cloud_deploy_logs.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ type KoolDeployLogsFlags struct {
func NewDeployLogsCommand(deployLogs *KoolDeployLogs) (cmd *cobra.Command) {
cmd = &cobra.Command{
Use: "logs [OPTIONS] SERVICE",
Short: "See the logs of running service container deployed to Kool Cloud",
Long: `After deploying an application to Kool Cloud using 'kool deploy',
Short: "See the logs of running service container deployed to Kool.dev Cloud",
Long: `After deploying an application to Kool.dev Cloud using 'kool deploy',
you can see the logs from the specified SERVICE container.
Must use a KOOL_API_TOKEN environment variable for authentication.`,
Args: cobra.ExactArgs(1),
Expand Down
6 changes: 3 additions & 3 deletions docs/02-Kool-Cloud/01-Getting-Started.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
The [Kool 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.
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.

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:[email protected]) for the **"Bring your Own Cloud"** offer.
**Kool 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.
**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

1. [Sign up for Kool Cloud](https://kool.dev/register) and get your access token.
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:
- `echo "KOOL_API_TOKEN=<my-token>" >> .env`
- Or you can store your token in a real environment variable:
Expand Down
6 changes: 3 additions & 3 deletions docs/02-Kool-Cloud/20-kool.cloud.yml-Reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ services:
- port: 80
```

Provided you have already signed up and obtained your access token for Kool Cloud in your `.env`, simply by running `kool cloud deploy`, you will get your container with `some/image` deployed to the cloud and a URL with HTTPS that will route incoming traffic to port 80 of that container.
Provided you have already signed up and obtained your access token for Kool.dev Cloud in your `.env`, simply by running `kool cloud deploy`, you will get your container with `some/image` deployed to the cloud and a URL with HTTPS that will route incoming traffic to port 80 of that container.

## Reference

Expand All @@ -38,7 +38,7 @@ services:
# Reference: https://docs.docker.com/compose/compose-file/compose-file-v3/#build
build: .
# Tells Kool Cloud that this service is accessible through the deployment URL.
# Tells Kool.dev Cloud that this service is accessible through the deployment URL.
# Note: only one service can be set to be public.
public: true # simply defining true is enough to most cases where your `expose` port will be used for routing incoming HTTP requests.

Expand Down Expand Up @@ -76,7 +76,7 @@ services:
# Tells what user and group should own the persisted folder (only used along the sync: true)
chown: user:group

# By default, Kool Cloud will rollout new deployments in a blue-green fashion.
# By default, Kool.dev Cloud will rollout new deployments in a blue-green fashion.
# If you want to disable it and make sure the current running container
# is stopped before the new one is created, set 'recreate: true'.
recreate: false
Expand Down
2 changes: 1 addition & 1 deletion docs/05-Commands-Reference/0-kool.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ kool

### SEE ALSO

* [kool cloud](kool-cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool-cloud) - Interact with Kool.dev Cloud and manage your deployments.
* [kool create](kool-create) - Create a new project using a preset
* [kool docker](kool-docker) - Create a new container (a powered up 'docker run')
* [kool exec](kool-exec) - Execute a command inside a running service container
Expand Down
6 changes: 3 additions & 3 deletions docs/05-Commands-Reference/kool-cloud-deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kool cloud deploy

Deploy a local application to a Kool Cloud environment
Deploy a local application to a Kool.dev Cloud environment

```
kool cloud deploy
Expand All @@ -19,12 +19,12 @@ kool cloud deploy

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

6 changes: 3 additions & 3 deletions docs/05-Commands-Reference/kool-cloud-destroy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kool cloud destroy

Destroy an environment deployed to Kool Cloud
Destroy an environment deployed to Kool.dev Cloud

```
kool cloud destroy
Expand All @@ -16,12 +16,12 @@ kool cloud destroy

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

8 changes: 4 additions & 4 deletions docs/05-Commands-Reference/kool-cloud-exec.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kool cloud exec

Execute a command inside a running service container deployed to Kool Cloud
Execute a command inside a running service container deployed to Kool.dev Cloud

### Synopsis

After deploying an application to Kool Cloud using 'kool deploy',
After deploying an application to Kool.dev Cloud using 'kool deploy',
execute a COMMAND inside the specified SERVICE container (similar to an SSH session).
Must use a KOOL_API_TOKEN environment variable for authentication.

Expand All @@ -23,12 +23,12 @@ kool cloud exec SERVICE [COMMAND] [--] [ARG...]

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

4 changes: 2 additions & 2 deletions docs/05-Commands-Reference/kool-cloud-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ kool cloud help [command] [flags]

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

8 changes: 4 additions & 4 deletions docs/05-Commands-Reference/kool-cloud-logs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kool cloud logs

See the logs of running service container deployed to Kool Cloud
See the logs of running service container deployed to Kool.dev Cloud

### Synopsis

After deploying an application to Kool Cloud using 'kool deploy',
After deploying an application to Kool.dev Cloud using 'kool deploy',
you can see the logs from the specified SERVICE container.
Must use a KOOL_API_TOKEN environment variable for authentication.

Expand All @@ -25,12 +25,12 @@ kool cloud logs [OPTIONS] SERVICE

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

4 changes: 2 additions & 2 deletions docs/05-Commands-Reference/kool-cloud-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ kool cloud setup

```
--domain string Environment domain name to deploy to
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
--verbose Increases output verbosity
-w, --working_dir string Changes the working directory for the command
```

### SEE ALSO

* [kool cloud](kool_cloud) - Interact with Kool Cloud and manage your deployments.
* [kool cloud](kool_cloud) - Interact with Kool.dev Cloud and manage your deployments.

14 changes: 7 additions & 7 deletions docs/05-Commands-Reference/kool-cloud.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kool cloud

Interact with Kool Cloud and manage your deployments.
Interact with Kool.dev Cloud and manage your deployments.

### Synopsis

The cloud subcommand encapsulates a set of APIs to interact with Kool Cloud and deploy, access and tail logs from your deployments.
The cloud subcommand encapsulates a set of APIs to interact with Kool.dev Cloud and deploy, access and tail logs from your deployments.

### Examples

Expand All @@ -17,7 +17,7 @@ kool cloud deploy
```
--domain string Environment domain name to deploy to
-h, --help help for cloud
--token string Token to authenticate with Kool Cloud API
--token string Token to authenticate with Kool.dev Cloud API
```

### Options inherited from parent commands
Expand All @@ -30,9 +30,9 @@ kool cloud deploy
### SEE ALSO

* [kool](kool) - Cloud native environments made easy
* [kool cloud deploy](kool_cloud_deploy) - Deploy a local application to a Kool Cloud environment
* [kool cloud destroy](kool_cloud_destroy) - Destroy an environment deployed to Kool Cloud
* [kool cloud exec](kool_cloud_exec) - Execute a command inside a running service container deployed to Kool Cloud
* [kool cloud logs](kool_cloud_logs) - See the logs of running service container deployed to Kool Cloud
* [kool cloud deploy](kool_cloud_deploy) - Deploy a local application to a Kool.dev Cloud environment
* [kool cloud destroy](kool_cloud_destroy) - Destroy an environment deployed to Kool.dev Cloud
* [kool cloud exec](kool_cloud_exec) - Execute a command inside a running service container deployed to Kool.dev Cloud
* [kool cloud logs](kool_cloud_logs) - See the logs of running service container deployed to Kool.dev Cloud
* [kool cloud setup](kool_cloud_setup) - Set up local configuration files for deployment

4 changes: 2 additions & 2 deletions services/cloud/api/endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ func (e *DefaultEndpoint) DoCall() (err error) {
reqURL := fmt.Sprintf("%s/%s?%s", apiBaseURL, e.path, e.query.Encode())

if verbose {
fmt.Fprintf(os.Stderr, "[Kool Cloud] Going to call: %s\n", reqURL)
fmt.Fprintf(os.Stderr, "[Kool.dev Cloud] Going to call: %s\n", reqURL)
}

if request, err = http.NewRequest(e.method, reqURL, body); err != nil {
Expand All @@ -207,7 +207,7 @@ func (e *DefaultEndpoint) DoCall() (err error) {
}

if verbose {
fmt.Fprintf(os.Stderr, "[Kool Cloud] Got: %s\n", string(raw))
fmt.Fprintf(os.Stderr, "[Kool.dev Cloud] Got: %s\n", string(raw))
}

if e.statusCode >= 400 {
Expand Down
2 changes: 1 addition & 1 deletion services/cloud/deploy_validator.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type DeployConfig struct {

// CloudConfig is the configuration for a deploy parsed from kool.cloud.yml
type CloudConfig struct {
// version of the Kool Cloud config file
// version of the Kool.dev Cloud config file
Version string `yaml:"version"`

// services is a map of services to deploy
Expand Down
4 changes: 2 additions & 2 deletions templates/kool.deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ services:
# Applications usually will require a special image built for deployment.
build: Dockerfile

# Tells Kool Cloud that this service is accessible through the deployment URL.
# Tells Kool.dev Cloud that this service is accessible through the deployment URL.
# Note: only one service can be set to be public.
public:
# Tells the port that should be used for routing incoming HTTP traffic.
Expand Down Expand Up @@ -40,7 +40,7 @@ services:
# Tells what user and group should own the persisted folder (only used along the sync: true)
chown: user:group

# By default, Kool Cloud will rollout new deployments in a blue-green fashion.
# By default, Kool.dev Cloud will rollout new deployments in a blue-green fashion.
# If you want to disable it and make sure the current running container
# stopped before the new one is created, set 'recreate: true'.
recreate: false
Expand Down

0 comments on commit c18c3cf

Please sign in to comment.