confctl 1.0.0

data/template/confctl-options.nix/main.erb

@@ -0,0 +1,45 @@
+# confctl-options.nix 8           <%= date.strftime('%Y-%m-%d') %>                             <%= version %>
+
+## NAME
+`confctl-options.nix` - confctl configuration documentation
+
+## DESCRIPTION
+This document describes Nix options, which can be used in confctl(8) cluster
+configurations to configure `confctl` and machines within the cluster.
+
+## CONFCTL SETTINGS
+The following `confctl` settings can be configured in `configs/confctl.nix`
+within the deployment configuration directory:
+
+<%= print_options(opts.confctl_settings) %>
+
+## SOFTWARE PIN CHANNELS
+The following `confctl` settings for software pin channels can be configured
+in `configs/swpins.nix` within the deployment configuration directory:
+
+<%= print_options(opts.swpin_settings) %>
+
+## MACHINE CONFIGURATION
+The following options can be configured in per-machine `module.nix` files within
+the deployment configuration directory, i.e. `cluster/<machine-name>/module.nix`:
+
+<%= print_options(opts.machine_settings) %>
+
+## SERVICES
+The following options can be configured in per-machine `config.nix` files within
+the deployment configuration directory, i.e. `cluster/<machine-name>/config.nix`,
+or any other imported Nix file. These options are added by `confctl` in addition
+to options from `NixOS` or `vpsAdminOS`.
+
+<%= print_options(opts.service_settings) %>
+
+## SEE ALSO
+confctl(8)
+
+## BUGS
+Report bugs to https://github.com/vpsfreecz/confctl/issues.
+
+## ABOUT
+`confctl` was originally developed for the purposes of
+[vpsFree.cz](https://vpsfree.org) and its cluster
+[configuration](https://github.com/vpsfreecz/vpsfree-cz-configuration).

data/template/confctl-options.nix/options.erb

@@ -0,0 +1,15 @@
+<% opts.each do |opt| -%>
+`<%= opt.name %>`
+  <%= indent(opt.md_description, 2) %>
+
+    *Type:* <%= opt.type %>
+
+    *Default:* `<%= opt.nix_default %>`
+<% if opt.example -%>
+
+    *Example:* `<%= opt.nix_example %>`
+<% end -%>
+
+    *Declared by:* <%= opt.declarations.map { |v| "`#{v}`" }.join(', ') %>
+
+<% end -%>

metadata

@@ -0,0 +1,353 @@
+--- !ruby/object:Gem::Specification
+name: confctl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jakub Skokan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.21.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: md2man
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: tty-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: vpsfree-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+description: Nix deployment management tool
+email: jakub.skokan@vpsfree.cz
+executables:
+- confctl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/confctl
+- confctl.gemspec
+- example/.gitignore
+- example/README.md
+- example/cluster/cluster.nix
+- example/cluster/module-list.nix
+- example/cluster/nixos-machine/config.nix
+- example/cluster/nixos-machine/hardware.nix
+- example/cluster/nixos-machine/module.nix
+- example/cluster/vpsadminos-container/config.nix
+- example/cluster/vpsadminos-container/module.nix
+- example/cluster/vpsadminos-machine/config.nix
+- example/cluster/vpsadminos-machine/hardware.nix
+- example/cluster/vpsadminos-machine/module.nix
+- example/cluster/vpsfreecz-vps/config.nix
+- example/cluster/vpsfreecz-vps/module.nix
+- example/configs/confctl.nix
+- example/configs/swpins.nix
+- example/data/default.nix
+- example/data/ssh-keys.nix
+- example/environments/base.nix
+- example/modules/module-list.nix
+- example/shell.nix
+- example/swpins/channels/nixos-unstable.json
+- example/swpins/channels/vpsadminos-staging.json
+- lib/confctl.rb
+- lib/confctl/cli.rb
+- lib/confctl/cli/app.rb
+- lib/confctl/cli/attr_filters.rb
+- lib/confctl/cli/cluster.rb
+- lib/confctl/cli/command.rb
+- lib/confctl/cli/configuration.rb
+- lib/confctl/cli/gen_data.rb
+- lib/confctl/cli/generation.rb
+- lib/confctl/cli/log_view.rb
+- lib/confctl/cli/output_formatter.rb
+- lib/confctl/cli/swpins.rb
+- lib/confctl/cli/swpins/base.rb
+- lib/confctl/cli/swpins/channel.rb
+- lib/confctl/cli/swpins/cluster.rb
+- lib/confctl/cli/swpins/core.rb
+- lib/confctl/cli/swpins/utils.rb
+- lib/confctl/cli/tag_filters.rb
+- lib/confctl/conf_cache.rb
+- lib/confctl/conf_dir.rb
+- lib/confctl/erb_template.rb
+- lib/confctl/exceptions.rb
+- lib/confctl/gcroot.rb
+- lib/confctl/generation/build.rb
+- lib/confctl/generation/build_list.rb
+- lib/confctl/generation/host.rb
+- lib/confctl/generation/host_list.rb
+- lib/confctl/generation/unified.rb
+- lib/confctl/generation/unified_list.rb
+- lib/confctl/git_repo_mirror.rb
+- lib/confctl/health_checks.rb
+- lib/confctl/health_checks/base.rb
+- lib/confctl/health_checks/run_command.rb
+- lib/confctl/health_checks/systemd/properties.rb
+- lib/confctl/health_checks/systemd/property_check.rb
+- lib/confctl/health_checks/systemd/property_list.rb
+- lib/confctl/hook.rb
+- lib/confctl/line_buffer.rb
+- lib/confctl/logger.rb
+- lib/confctl/machine.rb
+- lib/confctl/machine_control.rb
+- lib/confctl/machine_list.rb
+- lib/confctl/machine_status.rb
+- lib/confctl/module_options.rb
+- lib/confctl/nix.rb
+- lib/confctl/nix_build.rb
+- lib/confctl/nix_collect_garbage.rb
+- lib/confctl/nix_copy.rb
+- lib/confctl/nix_format.rb
+- lib/confctl/nix_literal_expression.rb
+- lib/confctl/parallel_executor.rb
+- lib/confctl/pattern.rb
+- lib/confctl/settings.rb
+- lib/confctl/std_line_buffer.rb
+- lib/confctl/swpins.rb
+- lib/confctl/swpins/change_set.rb
+- lib/confctl/swpins/channel.rb
+- lib/confctl/swpins/channel_list.rb
+- lib/confctl/swpins/cluster_name.rb
+- lib/confctl/swpins/cluster_name_list.rb
+- lib/confctl/swpins/core.rb
+- lib/confctl/swpins/deployed_info.rb
+- lib/confctl/swpins/spec.rb
+- lib/confctl/swpins/specs/base.rb
+- lib/confctl/swpins/specs/directory.rb
+- lib/confctl/swpins/specs/git.rb
+- lib/confctl/swpins/specs/git_rev.rb
+- lib/confctl/system_command.rb
+- lib/confctl/user_script.rb
+- lib/confctl/user_scripts.rb
+- lib/confctl/utils/file.rb
+- lib/confctl/version.rb
+- man/man8/confctl-options.nix.8
+- man/man8/confctl-options.nix.8.md
+- man/man8/confctl.8
+- man/man8/confctl.8.md
+- nix/evaluator.nix
+- nix/lib/default.nix
+- nix/lib/machine/default.nix
+- nix/lib/machine/info.nix
+- nix/lib/swpins/eval.nix
+- nix/lib/swpins/options.nix
+- nix/machines.nix
+- nix/modules/cluster/default.nix
+- nix/modules/confctl/cli.nix
+- nix/modules/confctl/generations.nix
+- nix/modules/confctl/nix.nix
+- nix/modules/confctl/swpins.nix
+- nix/modules/module-list.nix
+- shell.nix
+- template/confctl-options.nix/main.erb
+- template/confctl-options.nix/options.erb
+homepage:
+licenses:
+- GPL-3.0-only
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Nix deployment management tool
+test_files: []