diff --git a/README.md b/README.md index 0fa46ee0..fea53502 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/commands/cloud.go b/commands/cloud.go index 665b679f..b135adc4 100644 --- a/commands/cloud.go +++ b/commands/cloud.go @@ -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, @@ -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") return } } else if cloud.flags.Token != "" { @@ -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 diff --git a/commands/cloud_deploy.go b/commands/cloud_deploy.go index bb866d5e..c4533464 100644 --- a/commands/cloud_deploy.go +++ b/commands/cloud_deploy.go @@ -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, diff --git a/commands/cloud_deploy_destroy.go b/commands/cloud_deploy_destroy.go index 88b93b14..e61f6609 100644 --- a/commands/cloud_deploy_destroy.go +++ b/commands/cloud_deploy_destroy.go @@ -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), diff --git a/commands/cloud_deploy_exec.go b/commands/cloud_deploy_exec.go index abc989ba..c0af68c3 100644 --- a/commands/cloud_deploy_exec.go +++ b/commands/cloud_deploy_exec.go @@ -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), diff --git a/commands/cloud_deploy_logs.go b/commands/cloud_deploy_logs.go index 681638a9..b09edc14 100644 --- a/commands/cloud_deploy_logs.go +++ b/commands/cloud_deploy_logs.go @@ -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), diff --git a/docs/02-Kool-Cloud/01-Getting-Started.md b/docs/02-Kool-Cloud/01-Getting-Started.md index d94cefbb..1fa6f488 100644 --- a/docs/02-Kool-Cloud/01-Getting-Started.md +++ b/docs/02-Kool-Cloud/01-Getting-Started.md @@ -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:contact@kool.dev) 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=" >> .env` - Or you can store your token in a real environment variable: diff --git a/docs/02-Kool-Cloud/20-kool.cloud.yml-Reference.md b/docs/02-Kool-Cloud/20-kool.cloud.yml-Reference.md index a80c36f8..e5237a24 100644 --- a/docs/02-Kool-Cloud/20-kool.cloud.yml-Reference.md +++ b/docs/02-Kool-Cloud/20-kool.cloud.yml-Reference.md @@ -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 @@ -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. @@ -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 diff --git a/docs/05-Commands-Reference/0-kool.md b/docs/05-Commands-Reference/0-kool.md index ee1b5956..1c280d34 100644 --- a/docs/05-Commands-Reference/0-kool.md +++ b/docs/05-Commands-Reference/0-kool.md @@ -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 diff --git a/docs/05-Commands-Reference/kool-cloud-deploy.md b/docs/05-Commands-Reference/kool-cloud-deploy.md index 083a5105..1fc34dd9 100644 --- a/docs/05-Commands-Reference/kool-cloud-deploy.md +++ b/docs/05-Commands-Reference/kool-cloud-deploy.md @@ -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 @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud-destroy.md b/docs/05-Commands-Reference/kool-cloud-destroy.md index c9ae43ce..73c2f6e4 100644 --- a/docs/05-Commands-Reference/kool-cloud-destroy.md +++ b/docs/05-Commands-Reference/kool-cloud-destroy.md @@ -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 @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud-exec.md b/docs/05-Commands-Reference/kool-cloud-exec.md index a9cc9a51..f9da3e65 100644 --- a/docs/05-Commands-Reference/kool-cloud-exec.md +++ b/docs/05-Commands-Reference/kool-cloud-exec.md @@ -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. @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud-help.md b/docs/05-Commands-Reference/kool-cloud-help.md index 0af29b88..28fd18a7 100644 --- a/docs/05-Commands-Reference/kool-cloud-help.md +++ b/docs/05-Commands-Reference/kool-cloud-help.md @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud-logs.md b/docs/05-Commands-Reference/kool-cloud-logs.md index 65c1aeab..198a609b 100644 --- a/docs/05-Commands-Reference/kool-cloud-logs.md +++ b/docs/05-Commands-Reference/kool-cloud-logs.md @@ -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. @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud-setup.md b/docs/05-Commands-Reference/kool-cloud-setup.md index 67f8db6f..654c28b5 100644 --- a/docs/05-Commands-Reference/kool-cloud-setup.md +++ b/docs/05-Commands-Reference/kool-cloud-setup.md @@ -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. diff --git a/docs/05-Commands-Reference/kool-cloud.md b/docs/05-Commands-Reference/kool-cloud.md index ebd3aef8..7563599d 100644 --- a/docs/05-Commands-Reference/kool-cloud.md +++ b/docs/05-Commands-Reference/kool-cloud.md @@ -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 @@ -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 @@ -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 diff --git a/services/cloud/api/endpoint.go b/services/cloud/api/endpoint.go index 885a4804..e4e3ea9a 100644 --- a/services/cloud/api/endpoint.go +++ b/services/cloud/api/endpoint.go @@ -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 { @@ -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 { diff --git a/services/cloud/deploy_validator.go b/services/cloud/deploy_validator.go index 15adbd6b..fb460cf1 100644 --- a/services/cloud/deploy_validator.go +++ b/services/cloud/deploy_validator.go @@ -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 diff --git a/templates/kool.deploy.yml b/templates/kool.deploy.yml index 9f1003da..d8aa78f2 100644 --- a/templates/kool.deploy.yml +++ b/templates/kool.deploy.yml @@ -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. @@ -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