cpl 1.1.1 → 1.1.2.rc.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea3952c523b5ee8b9815befa82df1ecaee53a323a37f081344660d27f3003371
-  data.tar.gz: e346e1f6327ab009d0b801b651350355ad74cb9abbf9d69bb04fa46be00c4ea3
+  metadata.gz: bd0eff627240313d5202ff74368af8fff67483bcf0769f52f9c923a0839bfd73
+  data.tar.gz: a31c430587ecfce5cc1e7ede82ce31a0c91aec07de401fa849d18f75035dc4f1
 SHA512:
-  metadata.gz: d1b0bfc22da8b9209720e8a262739dcbd738722713165370203e471f52e2aedd52087196dd5b476f05d0dc5f744cdbebe861c1840c2aa32f95339cdafa175807
-  data.tar.gz: c067f243e3aabb72c271e02c7dd937355bf01e98645f4d163982143ad8a5e19cccdb19574dbe799e2eb7ac215a6f9e89db67f26e7e234252d227f5972b122331
+  metadata.gz: 770a3ab110f7b5b7049103c50350044805ed74c1ffedf61249d9696c94877fba43cd2bef031f6d9fd2dd70f2e29e2f970cd2d32cecadd6d7a2eaa3048bd493eb
+  data.tar.gz: ec006511deb5b41610f9d4780e02c1265eddfde523f95e3c7c373ef787039c3f5cb9a99c0132da020cd649029ea6e355b37f51fb3d4035381b10724c2ac4a4d4

data/CHANGELOG.md

@@ -14,6 +14,13 @@ Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+## [1.1.2] - 2023-10-17
+### Fixed
+
+- Fixed failed build on MacOS by adding platform flag and fixed multiple files in yaml document for template. [PR 81](https://github.com/shakacode/heroku-to-control-plane/pull/81) by [justin808](https://github.com/justin808).
+
+## [1.1.1] - 2023-09-23
+
 ### Fixed
 
 - Fixed issue where API token is not reset when switching profile. [PR 77](https://github.com/shakacode/heroku-to-control-plane/pull/77) by [Rafael Gomes](https://github.com/rafaelgomesxyz).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cpl (1.1.1)
+    cpl (1.1.2.rc.0)
       debug (~> 1.7.1)
       dotenv (~> 2.8.1)
       psych (~> 5.1.0)
@@ -25,7 +25,7 @@ GEM
     hashdiff (1.0.1)
     iniparse (1.5.0)
     io-console (0.6.0)
-    irb (1.8.1)
+    irb (1.8.3)
       rdoc
       reline (>= 0.3.8)
     json (2.6.3)
@@ -36,7 +36,7 @@ GEM
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
-    psych (5.1.0)
+    psych (5.1.1.1)
       stringio
     public_suffix (5.0.1)
     rainbow (3.1.1)
@@ -44,7 +44,7 @@ GEM
     rdoc (6.5.0)
       psych (>= 4.0.0)
     regexp_parser (2.6.2)
-    reline (0.3.8)
+    reline (0.3.9)
       io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.12.0)

data/README.md

@@ -6,7 +6,7 @@
 <meta name="keywords" content="Control Plane, Heroku, Kubernetes, K8, Infrastructure">
 <meta name="google-site-verification" content="dIV4nMplcYl6YOKOaZMqgvdKXhLJ4cdYY6pS6e_YrPU" />
 
-_A playbook for migrating from [Heroku](https://heroku.com) to [Control Plane](https://controlplane.com)_
+_A gem that provides **Heroku Flow** functionality on Control Plane, including docs for migrating from [Heroku](https://heroku.com) to [Control Plane](https://controlplane.com)_
 
 [![RSpec](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml/badge.svg)](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rspec.yml)
 [![Rubocop](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rubocop.yml/badge.svg)](https://github.com/shakacode/heroku-to-control-plane/actions/workflows/rubocop.yml)
@@ -89,21 +89,23 @@ For the typical Rails app, this means:
 
 ## Installation
 
+1. Ensure your [Control Plane](https://controlplane.com) account is set up. Set up an `organization` <your-org> for testing in that account and modify value for `aliases.common.cpln_org` in `.controlplane/controlplane.yml`. If you need an organization, please [contact Shakcode](mailto:controlplane@shkacode.com).
 1. Install [Node.js](https://nodejs.org/en) (required for Control Plane CLI).
-2. Install [Ruby](https://www.ruby-lang.org/en/) (required for these helpers).
-3. Install Control Plane CLI (adds `cpln` command) and configure credentials.
 
+1. Install [Ruby](https://www.ruby-lang.org/en/) (required for these helpers).
+
+1. Install Control Plane CLI (and configure access) [docs here](https://docs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli), `npm install -g @controlplane/cli`. You can update the `cpln` command line with `npm update -g @controlplane/cli`. Then run `cpln login` to ensure access.
 ```sh
 npm install -g @controlplane/cli
 cpln login
 ```
 
-4. Install Heroku to Control Plane `cpl` CLI, either as a [Ruby gem](https://rubygems.org/gems/cpl) or a local clone.
-   For information on the latter, see [CONTRIBUTING.md](CONTRIBUTING.md).
+1. Run `cpln image docker-login --org <your-org>` to ensure that you have access to the Control Plane Docker registry.
 
-```sh
-gem install cpl
-```
+1. Install Heroku to Control Plane `cpl` CLI, either as a [Ruby gem](https://rubygems.org/gems/cpl) or a local clone.
+   For information on the latter, see [CONTRIBUTING.md](CONTRIBUTING.md). You may also install `cpl` in your project's Gemfile.
+
+1. This project has a `Dockerfile` for Control Plane in this directory. You can use it as an example for your project. Ensure that you have Docker running.
 
 **Note:** Do not confuse the `cpl` CLI with the `cpln` CLI. The `cpl` CLI is the Heroku to Control Plane playbook CLI.
 The `cpln` CLI is the Control Plane CLI.
@@ -112,10 +114,32 @@ The `cpln` CLI is the Control Plane CLI.
 
 Click [here](/docs/migrating.md) to see the steps to migrate.
 
-## Config
+## Configuration Files
 
-Here's a complete example of all supported config keys explained:
+The `cpl` gem is based on several configuration files within a `/.controlplane` top-level directory in your Rails project.
 
+```
+.controlplane/
+├─ templates/
+│  ├─ gvc.yml
+│  ├─ postgres.yml
+│  ├─ rails.yml
+├─ controlplane.yml
+├─ Dockerfile
+├─ entrypoint.sh
+```
+
+1. `controlplane.yml` describes the overall application. Be sure to have <your-org> as the value for `aliases.common.cpln_org`.
+2. `Dockerfile` builds the production application. `entrypoint.sh` is an _example_ entrypoint script for the production application, referenced in your Dockerfile.
+3. `templates` directory contains the templates for the various workloads, such as `rails.yml` and `postgres.yml`.
+4. `templates/gvc.yml` defines your project's GVC (like a Heroku app). Most importantly, it contains ENV values for app.
+5. `templates/rails.yml` defines your Rails workload. It may inherit ENV values from the parent GVC, which is populated from the `templates/gvc.yml`. This file also configures scaling, sizing, firewalls, and other workload specific values.
+6. For other workloads (like lines in a Heroku Procfile), you create additional template files. For example, you can base a `templates/sidekiq.yml` on the `templates/rails.yml` file.
+7. You can have other files in the `templates` directory, such as `redis.yml` and `postgres.yml` which could setup Redis and Postgres for a testing application.
+
+Here's a complete example of all supported config keys explained for the `controlplane.yml` file:
+                                                       
+### `controlplane.yml`
 ```yaml
 # Keys beginning with "cpln_" correspond to your settings in Control Plane.
 
@@ -208,6 +232,61 @@ apps:
     dockerfile: ../some_other/Dockerfile
 ```
 
+## Workflow
+
+For a live example, see the [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.controlplane/readme.md).
+This example should closely match the below example.
+
+Suppose your app is called `tutorial-app`. You can run the following commands.
+
+### Setup Commands
+```sh
+# Provision all infrastructure on Control Plane.
+# app tutorial-app will be created per definition in .controlplane/controlplane.yml
+cpl apply-template gvc postgres redis rails -a tutorial-app
+
+# Build and push docker image to Control Plane repository
+# Note, may take many minutes. Be patient. Check for error messages, such as forgetting to run `cpln image docker-login --org <your-org>`
+cpl build-image -a tutorial-app
+
+# Promote image to app after running `cpl build-image command`
+# Note, the UX of images may not show the image for up to 5 minutes. However, it's ready.
+cpl deploy-image -a tutorial-app
+
+# See how app is starting up
+cpl logs -a tutorial-app
+
+# Open app in browser (once it has started up)
+cpl open -a tutorial-app
+```
+
+### Promoting code updates
+
+After committing code, you will update your deployment of `tutorial-app` with the following commands:
+
+```sh
+# Build and push new image with sequential image tagging, e.g. 'tutorial-app:1', then 'tutorial-app:2', etc.
+cpl build-image -a tutorial-app
+
+# Run database migrations (or other release tasks) with latest image,
+# while app is still running on previous image.
+# This is analogous to the release phase.
+cpl runner rails db:migrate -a tutorial-app --image latest
+
+# Pomote latest image to app
+cpl deploy-image -a tutorial-app
+```
+
+If you needed to push a new image with a specific commit SHA, you can run the following command:
+
+```sh
+# Build and push with sequential image tagging and commit SHA, e.g. 'tutorial-app:123_ABCD'
+cpl build-image -a tutorial-app --commit ABCD
+```
+
+### Real World
+Most companies will configure their CI system to handle the above steps. Please [contact Shakcode](mailto:controlplane@shkacode.com) for examples of how to do this, jump on [**React+Rails Slack channel**] (https://reactrails.slack.com/join/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE).
+
 ## Environment
 
 There are two main places where we can set up environment variables in Control Plane:
@@ -227,16 +306,18 @@ It is also possible to set up a Secret store (of type `Dictionary`), which we ca
 `cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_VAR_NAME`. In such a case, we must set up an app Identity and proper
 Policy to access the secret.
 
+In `templates/gvc.yml`:
 ```yaml
-# In `templates/gvc.yml`:
 spec:
   env:
     - name: MY_GLOBAL_VAR
       value: 'value'
     - name: MY_SECRET_GLOBAL_VAR
       value: 'cpln://secret/MY_SECRET_STORE_NAME/MY_SECRET_GLOBAL_VAR'
+```
 
-# In `templates/rails.yml`:
+In `templates/rails.yml`:
+```yaml
 spec:
   containers:
     - name: rails

data/lib/command/apply_template.rb

@@ -130,7 +130,8 @@ module Command
                  .gsub("APP_ORG", config.org)
                  .gsub("APP_IMAGE", latest_image)
 
-      cp.apply(YAML.safe_load(data))
+      # Don't read in YAML.safe_load as that doesn't handle multiple documents
+      cp.apply_template(data)
     end
 
     def report_success(template)

data/lib/command/run.rb

@@ -111,7 +111,7 @@ module Command
       end
 
       # Create workload clone
-      cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)
+      cp.apply_hash("kind" => "workload", "name" => one_off, "spec" => spec)
     end
 
     def runner_script # rubocop:disable Metrics/MethodLength

data/lib/command/run_detached.rb

@@ -104,7 +104,7 @@ module Command
       container_spec["env"] << { "name" => "CONTROLPLANE_RUNNER", "value" => runner_script }
 
       # Create workload clone
-      cp.apply("kind" => "workload", "name" => one_off, "spec" => spec)
+      cp.apply_hash("kind" => "workload", "name" => one_off, "spec" => spec)
     end
 
     def runner_script # rubocop:disable Metrics/MethodLength

data/lib/core/controlplane.rb

@@ -44,7 +44,10 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   end
 
   def image_build(image, dockerfile:, build_args: [], push: true)
-    cmd = "docker build -t #{image} -f #{dockerfile}"
+    # https://docs.controlplane.com/guides/push-image#step-2
+    # Might need to use `docker buildx build` if compatiblitity issues arise
+    cmd = "docker build --platform=linux/amd64 -t #{image} -f #{dockerfile}"
+
     build_args.each { |build_arg| cmd += " --build-arg #{build_arg}" }
     cmd += " #{config.app_dir}"
     perform!(cmd)
@@ -273,8 +276,21 @@ class Controlplane # rubocop:disable Metrics/ClassLength
   end
 
   # apply
+  def apply_template(data) # rubocop:disable Metrics/MethodLength
+    Tempfile.create do |f|
+      f.write(data)
+      f.rewind
+      cmd = "cpln apply #{gvc_org} --file #{f.path} > /dev/null"
+      if Shell.tmp_stderr
+        cmd += " 2> #{Shell.tmp_stderr.path}"
+        perform(cmd)
+      else
+        perform!(cmd)
+      end
+    end
+  end
 
-  def apply(data) # rubocop:disable Metrics/MethodLength
+  def apply_hash(data) # rubocop:disable Metrics/MethodLength
     Tempfile.create do |f|
       f.write(data.to_yaml)
       f.rewind

data/lib/cpl/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Cpl
-  VERSION = "1.1.1"
+  VERSION = "1.1.2.rc.0"
   MIN_CPLN_VERSION = "0.0.71"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpl
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2.rc.0
 platform: ruby
 authors:
 - Justin Gordon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -303,9 +303,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.12
 signing_key: