renuo-cli 4.16.0 → 4.17.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d2be942a488e9f935ad409f20fa275aea27af14713c6b98b155718208fbbbe
-  data.tar.gz: 8b854cf2514442624fe57d6f25e6540575140f14b2ece1ecda41ad2f5ef767cb
+  metadata.gz: 4bd8ae089520815a2934d6aa8bd1b7209af01e717c1e623c0a53bfb0cda0931e
+  data.tar.gz: 49c94fd014528566a51727e6f7938b56ff8a0ec37aa93c5a4292b3ba10a0abd2
 SHA512:
-  metadata.gz: 2b3b6acf9f8c2899d818ab72a1429835fc3f94ad003d8d6974c2bbee8d39819aeec07e5c947dd814f0626d1151fc007dff8d78664b7f84bd63d3d1ef2c6b68cc
-  data.tar.gz: 612d0f7b4f197079cbb8e48c0cf7262a9d07f175e03c2318a7cc7a803451bc0c39c812ecebf13cd07b0c666090c0c21b1eedfecba3105ba6758fc616436349de
+  metadata.gz: 6d960d53deb1dc144cfeaa77311732139c0e29f651567934a7fbd3ea9d3a812f8f6fa77f83d90338ccc4fe55bf3f7a528aaa1e2191dbb120f09db031a13c8582
+  data.tar.gz: e70f032d4d4c1b7323cd5fc177d93e6c9d37ff83b72a54e3ee5be368eb07e88132fd81e50233217ef862ce1b3d5df696bfb957390f664f40b530f4e0a13360b7

data/README.md

@@ -32,7 +32,8 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 ## Release
 
-* Bump the version number in `lib/renuo/cli/version.rb` and commit to `main`
+* Bump the version number in `lib/renuo/cli/version.rb`, run `bundle install`
+  to update the `Gemfile.lock` and commit to `main`
 
 ### Automatic
 

data/lib/renuo/cli/commands/check_deploio_status.rb

@@ -83,6 +83,11 @@ class Renuo::Cli::Commands::CheckDeploioStatus
     when "available", "success"
       puts "#{type} succeeded"
       true
+    when "superseded"
+      puts "release was superseded"
+      true
+    when "paused"
+      abort "app is paused"
     when "error", "failed", "failure"
       puts fetch_build_logs
       abort "#{type} failed"

data/lib/renuo/cli/commands/create_deploio_app.rb

@@ -20,13 +20,14 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
       - Configure repository access by generating SSH keys and adding them to 1Password.
       - Create the application and database for each specified environment.
     DESC
-    c.example "renuo create-deploio-app",
+    c.example "renuo create-deploio-app my-app git@github.com:renuo/my-app.git",
               "Prompts the user for the necessary information and generates the commands " \
               "to create the project, databases, and apps on Deploio."
-    c.action { new.run }
+    c.action { |args| new.run(args) }
   end
 
-  def run
+  def run(args)
+    @project_name, @git_url = args
     parse_arguments
     setup_commands
     setup_environments
@@ -59,12 +60,12 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
 
   def set_project_name
     loop do
-      @project_name = ask("Enter the project name (e.g: my-app): ")
-
       break if @project_name&.length&.between?(3, 63) && @project_name.match?(/^[a-z0-9-]+$/)
 
       say ">> Project name must be between 3 and 63 characters and can only contain lowercase letters, " \
           "numbers, and hyphens. Please try again.".colorize(:red)
+
+      @project_name = ask("Enter the project name (e.g: my-app): ")
     end
 
     @project_display_name = @project_name
@@ -73,10 +74,11 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
 
   def set_git_url
     loop do
-      @git_url = ask("Enter the git URL (e.g: git@github.com:my-org/my-app.git): ")
       break if @git_url.present? && git_url_valid?(@git_url)
 
       say ">> Git URL must be provided and valid. Please try again.".colorize(:red)
+
+      @git_url = ask("Enter the git URL: ") { |q| q.default = "git@github.com:renuo/#{@project_name}.git" }
     end
 
     return unless http_git_url?(@git_url)
@@ -87,27 +89,16 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
 
   def set_postgres_version
     loop do
-      @postgres_version = ask("Enter Postgres version (e.g., 16) or leave empty to skip database creation: ")
+      @postgres_version = ask("Enter Postgres version (e.g., 17) or leave empty to skip database creation: ")
       break if @postgres_version.empty? || @postgres_version.match?(/^\d+$/)
 
       say ">> The postgres version is invalid. Only major versions are allowed. " \
-          "For example, use 16 instead of 16.4. Please try again.".colorize(:red)
+          "For example, use 17 instead of 17.4. Please try again.".colorize(:red)
     end
   end
 
-  def set_vault_name # rubocop:disable Metrics/MethodLength
-    loop do
-      @vault_name = ask("Enter the 1Password vault name (leave empty to skip): ")
-      if @vault_name.empty?
-        say "Skipping 1Password vault setup. Defaulting to Deploio."
-        @vault_name = "Deploio"
-        break
-      elsif @vault_name.present?
-        break
-      else
-        say ">> The vault name must be provided. Please try again.".colorize(:red)
-      end
-    end
+  def set_vault_name
+    @vault_name = ask("Enter the 1Password vault name: ") { |q| q.default = "Deploio" }
   end
 
   def setup_commands
@@ -141,12 +132,20 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
   end
 
   def say_database_creation(environment)
-    say <<~OUTPUT
-      nctl create postgres #{environment} \\
-        --project=#{@project_name} \\
-        --postgres-version=#{@postgres_version} \\
-        --machine-type=nine-db-xs
-    OUTPUT
+    if environment == "main"
+      say <<~OUTPUT
+        nctl create postgres #{environment} \\
+          --project=#{@project_name} \\
+          --postgres-version=#{@postgres_version} \\
+          --machine-type=nine-db-xs
+      OUTPUT
+    else
+      say <<~OUTPUT
+        nctl create postgresdatabase #{environment} \\
+          --project=#{@project_name} \\
+          --postgres-database-version=#{@postgres_version}
+      OUTPUT
+    end
   end
 
   def say_app_creation(environment)
@@ -156,8 +155,8 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
         --git-ssh-private-key-from-file=#{GITHUB_SSH_KEY_FILE_NAME} \\
         --git-url=#{@git_url} \\
         --git-revision="#{environment}" \\
-        --basic-auth=false `# Disabling Deploio basic auth as Rails app handles authentication` \\
-        --build-env=SECRET_KEY_BASE='rails secret' `# Do not forget to generate the secret key` \\
+        --basic-auth=#{environment == "develop"} \\
+        --build-env=SECRET_KEY_BASE="$(rails secret)" \\
         --language=ruby \\
         --size=mini
     OUTPUT
@@ -167,6 +166,7 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
     say <<~OUTPUT
       # Create SSH key item in 1Password directly
       op item create \\
+        --account renuo.1password.com \\
         --category ssh \\
         --ssh-generate-key #{SSH_ALGORITHM.downcase} \\
         --title "#{@project_name}-deploy-key" \\
@@ -175,8 +175,10 @@ class Renuo::Cli::Commands::CreateDeploioApp # rubocop:disable Metrics/ClassLeng
 
       # Extract keys to temp files for deploio usage
       op item get "#{@project_name}-deploy-key" --vault #{@vault_name} \\
+        --account renuo.1password.com \\
         --reveal --fields "public key" > #{file_name}.pub
       op item get "#{@project_name}-deploy-key" --vault #{@vault_name} --reveal \\
+        --account renuo.1password.com \\
         --fields "private key" --format json | jq -r '.ssh_formats.openssh.value' > #{file_name}
     OUTPUT
   end

data/lib/renuo/cli/commands/create_deploio_object_storage.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+class Renuo::Cli::Commands::CreateDeploioObjectStorage
+  include CommandHelper
+
+  command "create-deploio-object-storage" do |c|
+    c.syntax = "renuo create-deploio-object-storage"
+    c.summary = "Generates the script necessary to setup object storage on Deploio."
+    c.description = <<~DESCRIPTION
+      This creates commands for creating buckets and bucket users.
+      It also guides you to set up ActiveStorage correctly, by setting the required ENV variables and config/storage.yml setting.
+
+      You will be asked for:
+      - project name so that the script can respect our naming conventions
+
+      The generated commands do the following:
+      - create a bucket user for each environment (main, develop)
+      - create buckets for each user who owns it
+      - enable versioning for main buckets
+    DESCRIPTION
+    c.example "Setup Deploio object storage (you will be asked for details)", "renuo create-deploio-object-storage"
+    c.example "renuo create-deploio-object-storage",
+              "Prompts the user for the necessary information and generates the commands " \
+              "to setup object storage on Deploio."
+    c.action { new.run }
+  end
+
+  def initialize
+    @project_name = ask('Project name (eg: "renuo-mtextur"): ') { |q| q.validate = /.+/ }
+    @location = ask('Location (Default: "nine-es34"): ') { |q| q.default = "nine-es34" }
+  end
+
+  BRANCHES = %w[main develop].freeze
+
+  def run
+    BRANCHES.each do |branch|
+      print_setup_commands(branch)
+    end
+    print_active_storage_config
+  end
+
+  private
+
+  def project_name_without_organisation
+    @project_name_without_organisation ||= @project_name.split("-")[1..].join("-")
+  end
+
+  def print_setup_commands(branch)
+    say "\n# Commands to create #{branch} bucket user and bucket\n".bold
+    versioning_flag = branch == "main" ? " --versioning" : ""
+    bucket_name = "#{project_name_without_organisation}-#{branch}"
+    say "nctl create bucketuser #{branch} --project #{@project_name} --location #{@location}\n"
+    say "nctl create bucket #{bucket_name} --project #{@project_name} --location #{@location}" \
+        "#{versioning_flag} --permissions reader=#{branch} --permissions writer=#{branch}\n"
+  end
+
+  def print_active_storage_config
+    say "\n# ActiveStorage Configuration".bold
+    print_storage_yml_config
+    print_retrieve_credentials
+    print_env_variables_config
+    print_active_storage_service_config
+  end
+
+  def print_storage_yml_config
+    puts <<~OUTPUT
+      Add the following service configuration to your "config/storage.yml" file:
+
+      deploio:
+        service: S3
+        access_key_id: <%= ENV["DEPLOIO_ACCESS_KEY"] %>
+        secret_access_key: <%= ENV["DEPLOIO_SECRET_KEY"] %>
+        endpoint: <%= ENV["DEPLOIO_ENDPOINT"] %>
+        region: us-east-1 # running in Switzerland, operated by Nine.
+        bucket: <%= ENV["DEPLOIO_BUCKET"] %>
+
+      INFO: For S3, a region must be specified. Deploio uses the S3 default value of us-east-1,
+      even though the servers are in Switzerland, operated by Nine.
+    OUTPUT
+  end
+
+  def print_retrieve_credentials
+    say "\n# Retrieve credentials from the bucket user".bold
+    say "After running the bucket user creation commands above, retrieve your credentials:\n\n"
+
+    BRANCHES.each do |branch|
+      say <<~OUTPUT
+        ## #{branch} environment credentials:
+        nctl get bucketuser #{branch} --project #{@project_name} --print-credentials
+
+      OUTPUT
+    end
+  end
+
+  def print_env_variables_config
+    say "\n# Set environment variables on your Deploio application".bold
+    say "Replace the placeholders with the values retrieved above:\n"
+
+    BRANCHES.each do |branch|
+      bucket_name = "#{project_name_without_organisation}-#{branch}"
+      say <<~OUTPUT
+
+        # #{branch} environment:
+        nctl update app #{branch} \\
+          --project #{@project_name} \\
+          --env="DEPLOIO_ACCESS_KEY={ACCESS_KEY}" \\
+          --env="DEPLOIO_SECRET_KEY={SECRET_KEY}" \\
+          --env="DEPLOIO_ENDPOINT=https://#{@location}.objects.nineapis.ch" \\
+          --env="DEPLOIO_BUCKET=#{bucket_name}"
+      OUTPUT
+    end
+  end
+
+  def print_active_storage_service_config
+    say "\n# Configure ActiveStorage in your Rails application".bold
+    say <<~OUTPUT
+      Set the ActiveStorage service in your production environment ("config/environments/production.rb"):
+
+      config.active_storage.service = :deploio
+    OUTPUT
+  end
+end

data/lib/renuo/cli/commands/fetch_secrets.rb

@@ -51,7 +51,8 @@ class Renuo::Cli::Commands::FetchSecrets # rubocop:disable Metrics/ClassLength
     end
 
     item_id = extract_item_id(private_link)
-    item_json = get_item(item_id)
+    account_id = extract_account_id(private_link)
+    item_json = get_item(item_id, account_id)
     return if item_json.nil?
 
     item[:env_variables]&.each do |env_variable|
@@ -67,8 +68,15 @@ class Renuo::Cli::Commands::FetchSecrets # rubocop:disable Metrics/ClassLength
     /&i=([^&]+)/.match(private_link)[1]
   end
 
-  def get_item(item_id)
-    output = execute_command(command: "op item get #{item_id} --format json",
+  def extract_account_id(private_link)
+    /&h=([^&]+)/.match(private_link)&.[](1)
+  end
+
+  def get_item(item_id, account_id = nil)
+    command = "op item get #{item_id} --format json"
+    command += " --account #{account_id}" if account_id
+
+    output = execute_command(command: command,
                              success_message: "",
                              error_message: "Error fetching item #{item_id}." \
                                             "Check `private_link` in  your #{CONFIG_FILE} file.")

data/lib/renuo/cli/version.rb

@@ -3,7 +3,7 @@
 # :nocov:
 module Renuo
   class Cli
-    VERSION = "4.16.0"
+    VERSION = "4.17.2"
     NAME = "renuo-cli"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renuo-cli
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.2
 platform: ruby
 authors:
 - Renuo AG
@@ -85,6 +85,7 @@ files:
 - lib/renuo/cli/commands/configure_sentry.rb
 - lib/renuo/cli/commands/create_aws_project.rb
 - lib/renuo/cli/commands/create_deploio_app.rb
+- lib/renuo/cli/commands/create_deploio_object_storage.rb
 - lib/renuo/cli/commands/create_heroku_app.rb
 - lib/renuo/cli/commands/create_new_logins.rb
 - lib/renuo/cli/commands/create_pr.rb
@@ -135,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.2
 specification_version: 4
 summary: The Renuo CLI automates some common workflows.
 test_files: []