cpflow 3.0.0

data/rakelib/create_release.rake

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "English"
+
+desc("Releases the gem package using the given version.
+
+  IMPORTANT: the gem version must be in valid rubygem format (no dashes).
+  This task depends on the gem-release ruby gem.
+
+  1st argument: The new version in rubygem format (no dashes). Pass no argument to
+                automatically perform a patch version bump.
+  2nd argument: Perform a dry run by passing 'true' as a second argument.
+
+  Example: `rake create_release[2.1.0,false]`")
+
+task :create_release, %i[gem_version dry_run] do |_t, args|
+  args_hash = args.to_hash
+
+  is_dry_run = Release.object_to_boolean(args_hash[:dry_run])
+  gem_version = args_hash.fetch(:gem_version, "").strip
+  gem_root = Release.gem_root
+
+  Release.update_the_local_project
+  Release.ensure_there_is_nothing_to_commit
+  Release.sh_in_dir(gem_root,
+                    "gem bump --no-commit #{gem_version == '' ? '' : %(--version #{gem_version})}")
+  Release.sh_in_dir(gem_root, "bundle install")
+  Release.sh_in_dir(gem_root, "git commit -am 'Bump version to #{gem_version}'")
+  Release.sh_in_dir(gem_root, "git push")
+
+  # See https://github.com/svenfuchs/gem-release
+  Release.release_the_new_gem_version unless is_dry_run
+end
+
+module Release
+  extend FileUtils
+  class << self
+    def gem_root
+      File.expand_path("..", __dir__)
+    end
+
+    # Executes a string or an array of strings in a shell in the given directory in an unbundled environment
+    def sh_in_dir(dir, *shell_commands)
+      shell_commands.flatten.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+    end
+
+    def ensure_there_is_nothing_to_commit
+      status = `git status --porcelain`
+
+      return if $CHILD_STATUS.success? && status == ""
+
+      error = if $CHILD_STATUS.success?
+                "You have uncommitted code. Please commit or stash your changes before continuing"
+              else
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
+              end
+      raise(error)
+    end
+
+    def object_to_boolean(value)
+      [true, "true", "yes", 1, "1", "t"].include?(value.instance_of?(String) ? value.downcase : value)
+    end
+
+    def update_the_local_project
+      puts "Pulling latest commits from remote repository"
+
+      sh_in_dir(gem_root, "git pull --rebase")
+      raise "Failed in pulling latest changes from default remote repository." unless $CHILD_STATUS.success?
+    rescue Errno::ENOENT
+      raise "Ensure you have Git and Bundler installed before continuing."
+    end
+
+    def release_the_new_gem_version
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+      puts "Use the OTP for RubyGems!"
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+
+      sh_in_dir(gem_root, "gem release --push --tag")
+    end
+  end
+end

data/script/add_command

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+command_name = ARGV[0]&.downcase
+
+abort("ERROR: Must provide command name.") unless command_name
+
+file_name = command_name.gsub(/[^A-Za-z]/, "_")
+file_path = "#{__dir__}/../lib/command/#{file_name}.rb"
+
+abort("ERROR: Command '#{command_name}' already exists.") if File.exist?(file_path)
+
+class_name = file_name.split("_").map(&:capitalize).join
+
+file_data =
+  <<~DATA
+    # frozen_string_literal: true
+
+    module Command
+      class #{class_name} < Base
+        # See `base.rb` for other constants to add here
+        NAME = "#{command_name}"
+        OPTIONS = [
+          # Add options here
+        ].freeze
+        DESCRIPTION = "Add description here"
+        LONG_DESCRIPTION = <<~DESC
+          - Add long description here
+        DESC
+
+        def call
+          # Add command logic here
+        end
+      end
+    end
+  DATA
+File.binwrite(file_path, file_data)

data/script/check_command_docs

@@ -0,0 +1,3 @@
+#!/bin/sh
+bundle exec rake update_command_docs
+git diff --exit-code || exit 1

data/script/check_cpln_links

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+bad_links=("controlplane.com/shakacode" "https://docs.controlplane.com")
+proper_links=("shakacode.controlplane.com" "https://shakadocs.controlplane.com")
+
+bold=$(tput bold)
+normal=$(tput sgr0)
+
+exit_status=0
+accumulated_results=""
+seen_bad_links_indexes=()
+
+for ((idx = 0; idx < ${#bad_links[@]}; idx++)); do
+    results=$(git grep \
+        --recursive \
+        --line-number \
+        --fixed-strings \
+        --break \
+        --heading \
+        --color=always -- \
+        "${bad_links[idx]}" \
+        ':!script/check_cpln_links' '*.md')
+
+    # Line would become really unwieldly if everything was mushed into the
+    # conditional, so let's ignore this check here.
+    # shellcheck disable=SC2181
+    if [ $? -eq 0 ]; then
+        accumulated_results+="$results"
+        seen_bad_links_indexes+=("$idx")
+        exit_status=1
+    fi
+done
+
+if [ "$exit_status" -eq 1 ]; then
+    echo "${bold}[!] Found the following bad links:${normal}"
+    echo ""
+    echo "$accumulated_results"
+    echo ""
+    echo "${bold}[*] Please update accordingly:${normal}"
+    for bad_link_index in "${seen_bad_links_indexes[@]}"; do
+        echo "  ${bad_links[bad_link_index]} -> ${proper_links[bad_link_index]}"
+    done
+fi
+
+exit "$exit_status"

data/script/rename_command

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "json"
+
+old_command_name = ARGV[0]&.downcase
+new_command_name = ARGV[1]&.downcase
+
+abort("ERROR: Must provide old and new command names.") unless old_command_name && new_command_name
+
+old_file_name = old_command_name.gsub(/[^A-Za-z]/, "_")
+old_file_path = "#{__dir__}/../lib/command/#{old_file_name}.rb"
+
+abort("ERROR: Command '#{old_command_name}' does not exist.") unless File.exist?(old_file_path)
+
+new_file_name = new_command_name.gsub(/[^A-Za-z]/, "_")
+new_file_path = "#{__dir__}/../lib/command/#{new_file_name}.rb"
+
+abort("ERROR: Command '#{new_command_name}' already exists.") if File.exist?(new_file_path)
+
+old_class_name = old_file_name.split("_").map(&:capitalize).join
+new_class_name = new_file_name.split("_").map(&:capitalize).join
+
+file_data = File.binread(old_file_path)
+file_data.gsub!(old_class_name, new_class_name)
+file_data.gsub!(old_command_name, new_command_name)
+File.binwrite(new_file_path, file_data)
+File.delete(old_file_path)
+
+# Add old command name to deprecated commands
+deprecated_commands_file_path = "#{__dir__}/../lib/deprecated_commands.json"
+old_deprecated_commands_data = File.binread(deprecated_commands_file_path)
+deprecated_commands = JSON.parse(old_deprecated_commands_data)
+deprecated_commands = deprecated_commands.to_h do |current_old_command_name, current_new_command_name|
+  if current_new_command_name == old_command_name
+    [current_old_command_name, new_command_name]
+  else
+    [current_old_command_name, current_new_command_name]
+  end
+end
+deprecated_commands[old_command_name] = new_command_name
+new_deprecated_commands_data = "#{JSON.pretty_generate(deprecated_commands.sort.to_h)}\n"
+File.binwrite(deprecated_commands_file_path, new_deprecated_commands_data)

data/script/update_command_docs

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/cpflow"
+
+commands_str_arr = []
+
+commands = Command::Base.all_commands
+commands.keys.sort.each do |command_key|
+  command_class = commands[command_key]
+
+  next if command_class::HIDE
+
+  name = command_class::NAME
+  usage = command_class::USAGE.empty? ? name : command_class::USAGE
+  options = command_class::OPTIONS
+  long_description = command_class::LONG_DESCRIPTION
+  examples = command_class::EXAMPLES
+
+  command_str = "### `#{name}`\n\n"
+  command_str += "#{long_description.strip}\n\n"
+
+  if examples.empty?
+    options_str_arr = []
+    options.each do |option|
+      next unless option[:params][:required]
+
+      options_str_arr.push("#{option[:params][:aliases][0]} $#{option[:params][:banner]}")
+    end
+    options_str = options_str_arr.join(" ")
+
+    command_str += "```sh\ncpflow #{usage}"
+    command_str += " #{options_str}" unless options_str.empty?
+    command_str += "\n```"
+  else
+    command_str += examples.strip
+  end
+
+  commands_str_arr.push(command_str)
+end
+
+commands_str = commands_str_arr.join("\n\n")
+
+file_path = "#{__dir__}/../docs/commands.md"
+file_data =
+  <<~DATA
+    <!-- NOTE: This file is automatically generated by running `script/generate_commands_docs`. Do NOT edit it manually. -->
+
+    ## Common Options
+
+    ```
+    -a XXX, --app XXX         app ref on Control Plane (GVC)
+    ```
+
+    This `-a` option is used in most of the commands and will pick all other app configurations from the project-specific
+    `.controlplane/controlplane.yml` file.
+
+    ## Commands
+
+    #{commands_str}
+  DATA
+File.binwrite(file_path, file_data)

data/templates/app.yml

@@ -0,0 +1,13 @@
+kind: gvc
+name: {{APP_NAME}}
+spec:
+  env:
+    - name: MEMCACHE_SERVERS
+      value: memcached.{{APP_NAME}}.cpln.local
+    - name: REDIS_URL
+      value: redis://redis.{{APP_NAME}}.cpln.local:6379
+    - name: DATABASE_URL
+      value: postgres://postgres:password123@postgres.{{APP_NAME}}.cpln.local:5432/{{APP_NAME}}
+  staticPlacement:
+    locationLinks:
+      - {{APP_LOCATION_LINK}}

data/templates/daily-task.yml

@@ -0,0 +1,32 @@
+kind: workload
+name: daily-task
+spec:
+  # https://docs.controlplane.com/reference/workload#cron-configuration
+  type: cron
+  job:
+    # Run daily job at 2am (see cron docs)
+    schedule: 0  2  *  *  *
+    # Never or OnFailure
+    restartPolicy: Never
+  containers:
+    - name: daily-task
+      cpu: 50m
+      memory: 256Mi
+      args:
+        - bundle
+        - exec
+        - rails
+        - db:prepare
+      inheritEnv: true
+      image: {{APP_IMAGE_LINK}}
+  defaultOptions:
+    autoscaling:
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    external:
+      outboundAllowCIDR:
+        - 0.0.0.0/0
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}

data/templates/maintenance.yml

@@ -0,0 +1,25 @@
+kind: workload
+name: maintenance
+spec:
+  type: standard
+  containers:
+    - name: maintenance
+      env:
+        - name: PORT
+          value: "3000"
+        - name: PAGE_URL
+          value: ""
+      image: "shakacode/maintenance-mode"
+      ports:
+        - number: 3000
+          protocol: http
+  defaultOptions:
+    autoscaling:
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+    timeoutSeconds: 60
+  firewallConfig:
+    external:
+      inboundAllowCIDR:
+        - 0.0.0.0/0

data/templates/memcached.yml

@@ -0,0 +1,24 @@
+kind: workload
+name: memcached
+spec:
+  type: standard
+  containers:
+    - name: memcached
+      cpu: 25m
+      memory: 32Mi
+      args:
+        - "-l"
+        - 0.0.0.0
+      image: "memcached:alpine"
+      ports:
+        - number: 11211
+          protocol: tcp
+  defaultOptions:
+    autoscaling:
+      metric: disabled
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    internal:
+      inboundAllowType: same-gvc

data/templates/postgres.yml

@@ -0,0 +1,32 @@
+kind: workload
+name: postgres
+spec:
+  type: standard
+  containers:
+    - name: postgres
+      cpu: 50m
+      memory: 200Mi
+      env:
+        - name: PGUSER
+          value: postgres
+        - name: POSTGRES_PASSWORD
+          value: password123
+        - name: POSTGRES_USER
+          value: postgres
+      image: "postgres:13.8-alpine"
+      ports:
+        - number: 5432
+          protocol: tcp
+      volumes:
+        - path: /var/lib/postgresql/data
+          recoveryPolicy: retain
+          uri: "scratch://postgres-vol"
+  defaultOptions:
+    autoscaling:
+      metric: disabled
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    internal:
+      inboundAllowType: same-gvc

data/templates/rails.yml

@@ -0,0 +1,27 @@
+kind: workload
+name: rails
+spec:
+  type: standard
+  containers:
+    - name: rails
+      cpu: 512m
+      memory: 1Gi
+      inheritEnv: true
+      image: {{APP_IMAGE_LINK}}
+      ports:
+        - number: 3000
+          protocol: http
+  defaultOptions:
+    autoscaling:
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+    timeoutSeconds: 60
+  firewallConfig:
+    external:
+      inboundAllowCIDR:
+        - 0.0.0.0/0
+      outboundAllowCIDR:
+        - 0.0.0.0/0
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}

data/templates/redis.yml

@@ -0,0 +1,21 @@
+kind: workload
+name: redis
+spec:
+  type: standard
+  containers:
+    - name: redis
+      cpu: 25m
+      memory: 32Mi
+      image: "redis:latest"
+      ports:
+        - number: 6379
+          protocol: tcp
+  defaultOptions:
+    autoscaling:
+      metric: disabled
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    internal:
+      inboundAllowType: same-gvc

data/templates/redis2.yml

@@ -0,0 +1,37 @@
+kind: volumeset
+name: redis-data
+spec:
+  fileSystemType: ext4
+  initialCapacity: 10
+  performanceClass: general-purpose-ssd
+---
+kind: workload
+name: redis2
+spec:
+  type: stateful
+  containers:
+    - name: redis
+      args:
+        - '--appendonly'
+        - 'yes'
+        - '--maxmemory'
+        - 25mb
+      cpu: 25m
+      memory: 32Mi
+      image: "redis:latest"
+      ports:
+        - number: 6379
+          protocol: tcp
+      volumes:
+        - path: /data
+          recoveryPolicy: retain
+          uri: cpln://volumeset/redis-data
+  defaultOptions:
+    autoscaling:
+      metric: disabled
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    internal:
+      inboundAllowType: same-gvc

data/templates/sidekiq.yml

@@ -0,0 +1,38 @@
+kind: workload
+name: sidekiq
+spec:
+  type: standard
+  containers:
+    - name: sidekiq
+      cpu: 50m
+      memory: 256Mi
+      args:
+        - bundle
+        - exec
+        - sidekiq
+        - "-C"
+        - config/sidekiq.yml
+      inheritEnv: true
+      image: {{APP_IMAGE_LINK}}
+      ports:
+        - number: 7433
+          protocol: http
+      lifecycle:
+        preStop:
+          exec:
+            command:
+              - pkill
+              - "-TSTP"
+              - "-f"
+              - ^sidekiq\s
+  defaultOptions:
+    autoscaling:
+      minScale: 1
+      maxScale: 1
+    capacityAI: false
+  firewallConfig:
+    external:
+      outboundAllowCIDR:
+        - 0.0.0.0/0
+  # Identity is used for binding workload to secrets
+  identityLink: {{APP_IDENTITY_LINK}}