r10k 3.3.3 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c5e1d56a50eeaca95e17ebce9b11b29bf0566f3
-  data.tar.gz: e823ba782b16a2a01e574b07452170f2142180bb
+SHA256:
+  metadata.gz: 8fa591e05f2bcb8e3e7acb9b4ac018ef5a3471832bca677a49c5a409f358b5a8
+  data.tar.gz: 9d27ceb63bc53563b419140a3de96b744171bb790d8fb12a2a4c73e4b3feb2cf
 SHA512:
-  metadata.gz: 89919d96fa8f6e0542112b6864cabde14244aba8986ad65d63940d1ccdcfd7209b79f24da6b23edd6a3d92c22c2e7a24f7a96f1ab96c5a2d2924dbed159ab665
-  data.tar.gz: 38efbca6d8315176df86caeff0c60888f15798700e3733b104542baa82dd6ad3dc87c061bc341d4f577d9e4f9640a517a9106ce988dcd1c77fd8433283c3df1a
+  metadata.gz: 1cc2808331cbcb0f52ce418eaea05995a96ddec0bc5e523b7179969d4f51609745912ae7a8e621104a704a40f71a7502bdc809d10948ea39961cb288a81ddd9c
+  data.tar.gz: 418fcc583a83105d5953cd1df74e4ea09735b427765c67f2600d357c3daade952a7d1242f102d1bf2c34b71aa8bcd7cfeca7416274d97911b2916a28b7b03571

data/.github/workflows/docker.yml

@@ -0,0 +1,32 @@
+name: Docker test and publish
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-publish:
+    env:
+      PUPPERWARE_ANALYTICS_STREAM: production
+      IS_LATEST: true
+      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+      DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - run: gem install bundler
+      - name: Build container
+        working-directory: docker
+        run: make lint build test
+      - name: Publish container
+        working-directory: docker
+        run: |
+          docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD"
+          make publish

data/.travis.yml

@@ -12,6 +12,8 @@ jdk:
 before_install: gem install bundler -v '< 2' --no-document
 matrix:
   include:
+    - stage: r10k tests
+      rvm: 2.6.5
     - stage: r10k tests
       rvm: 2.5.0
     - stage: r10k tests

data/CHANGELOG.mkd

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+3.4.0
+-----
+
+  - Switch to supported `colored2` gem
+  - Add YAML environment source types [#983](https://github.com/puppetlabs/r10k/pull/983), [#1002](https://github.com/puppetlabs/r10k/pull/1002). YAML source types use configuration files to define environments, rather than VCS branches, and support deploying modules to an environment without modifying a control-repo. YAML environment source types are experimental in this release
+
 3.3.3
 -----
 

data/CODEOWNERS

@@ -1 +1,2 @@
+*        @puppetlabs/puppetserver-maintainers
 /docker/ @puppetlabs/pupperware

data/README.mkd

@@ -17,7 +17,8 @@ implementation of Puppet [dynamic environments][workflow].
 Requirements
 ------------
 
-R10k supports the Ruby versions `>= 2.3.0`.
+R10k supports the Ruby versions `>= 2.3.0`. It's tested on Ruby 2.3.0 up to
+Ruby 2.6.0 + Jruby.
 
 R10k requires additional components, depending on how you plan on managing
 environments and modules.

data/bin/r10k

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'r10k/cli'
-require 'colored'
+require 'colored2'
 
 begin
   R10K::CLI.command.run(ARGV)

data/doc/dynamic-environments/configuration.mkd

@@ -263,7 +263,7 @@ After Puppetfile content for a given environment is deployed, r10k will
 recursively remove any content found in a directory managed by the Puppetfile
 which is not also declared in that Puppetfile. Directories considered to be
 managed by a Puppetfile include the configured `moduledir` (which defaults to
-"modules") as well as alternate directories specified as an `install\_path`
+"modules") as well as alternate directories specified as an `install_path`
 option to any Puppetfile content declarations.
 
 #### purge\_whitelist
@@ -509,3 +509,147 @@ This will create the following directory structure:
 |-- app1_production  # app1 data repository, production branch
 |-- app1_develop     # app1 data repository, develop branch
 ```
+
+Experimental Features
+---------------------
+
+### YAML Environment Source
+
+Dynamically deploying Puppet content based on the state of version control repositories can be powerful and efficient for development workflows. The linkage however is not advantageous when trying to build precision controls over deployment of previously-developed and tested content.
+
+The YAML environment source type allows for a clear separation of tooling between development workflow, and deployment workflow. Development workflow creates new commits in the version control system. Deployment workflow consumes them.
+
+To use the YAML environment source, configure r10k's sources with at least one entry using the yaml type.
+
+```yaml
+# r10k.yaml
+---
+sources:
+  puppet:
+    type: yaml
+    basedir: /etc/puppetlabs/code/environments
+    config: /etc/puppetlabs/r10k/environments.yaml # default
+```
+
+When using the YAML source type, every environment is enumerated in a single yaml file. Each environment specifies a type, source, and version (typically a Git ref) to deploy. In the following example, two environments are defined, which are identical to each other.
+
+```yaml
+---
+production:
+  type: git
+  remote: git@github.com:puppetlabs/control-repo.git
+  ref: 8820892
+
+development:
+  type: git
+  remote: git@github.com:puppetlabs/control-repo.git
+  ref: 8820892
+```
+
+### YAMLdir Environment Source
+
+Like the YAML environment source, but implemented as a conf.d pattern.
+
+```yaml
+# r10k.yaml
+---
+sources:
+  puppet:
+    type: yamldir
+    basedir: /etc/puppetlabs/code/environments
+    config: /etc/puppetlabs/r10k/environments.d # default
+```
+
+Each environment is defined in a yaml file placed in the configuration directory. The filename, without the .yaml extension, will be the name of the environment.
+
+```
+/etc/puppetlabs/r10k/environments.d
+├── production.yaml
+└── development.yaml
+```
+
+The contents of the file should be a hash specifying the enviornment type, and all other applicable environment options.
+
+```yaml
+# production.yaml
+---
+type: git
+remote: git@github.com:puppetlabs/control-repo.git
+ref: 8820892
+```
+
+### Environment Modules
+
+The environment modules feature allows module content to be attached to an environment at environment definition time. This happens before modules specified in a Puppetfile are attached to an environment, which does not happen until deploy time. Environment module implementation depends on the environment source type.
+
+For the YAML environment source type, attach modules to an environment by specifying a modules key for the environment, and providing a hash of modules to attach. Each module accepts the same arguments accepted by the `mod` method in a Puppetfile.
+
+The example below includes two Forge modules and one module sourced from a Git repository. The two environments are almost identical. However, a new version of the stdlib module has been deployed in development (6.2.0), that has not yet been deployed to production.
+
+```yaml
+---
+production:
+  type: git
+  remote: git@github.com:puppetlabs/control-repo.git
+  ref: 8820892
+  modules:
+    puppetlabs-stdlib: 6.0.0
+    puppetlabs-concat: 6.1.0
+    reidmv-xampl:
+      git: https://github.com/reidmv/reidmv-xampl.git
+      ref: 62d07f2
+
+development:
+  type: git
+  remote: git@github.com:puppetlabs/control-repo.git
+  ref: 8820892
+  modules:
+    puppetlabs-stdlib: 6.2.0
+    puppetlabs-concat: 6.1.0
+    reidmv-xampl:
+      git: https://github.com/reidmv/reidmv-xampl.git
+      ref: 62d07f2
+```
+
+An example of a single environment definition for the YAMLdir environment source type:
+
+```yaml
+# production.yaml
+---
+type: git
+remote: git@github.com:puppetlabs/control-repo.git
+ref: 8820892
+modules:
+  puppetlabs-stdlib: 6.0.0
+  puppetlabs-concat: 6.1.0
+  reidmv-xampl:
+    git: https://github.com/reidmv/reidmv-xampl.git
+    ref: 62d07f2
+```
+
+### Bare Environment Type
+
+A "control repository" typically contains a hiera.yaml, an environment.conf, a manifests/site.pp file, and a few other things. However, none of these are strictly necessary for an environment to be functional if modules can be deployed to it.
+
+The bare environment type allows sources that support environment modules to operate without a control repo being required. Modules can be deployed directly.
+
+```yaml
+---
+production:
+  type: bare
+  modules:
+    puppetlabs-stdlib: 6.0.0
+    puppetlabs-concat: 6.1.0
+    reidmv-xampl:
+      git: https://github.com/reidmv/reidmv-xampl.git
+      ref: 62d07f2
+
+development:
+  type: bare
+  modules:
+    puppetlabs-stdlib: 6.0.0
+    puppetlabs-concat: 6.1.0
+    reidmv-xampl:
+      git: https://github.com/reidmv/reidmv-xampl.git
+      ref: 62d07f2
+```

data/docker/Makefile

@@ -6,13 +6,21 @@ build_date := $(shell date -u +%FT%T)
 hadolint_available := $(shell hadolint --help > /dev/null 2>&1; echo $$?)
 hadolint_command := hadolint --ignore DL3008 --ignore DL3018 --ignore DL3028 --ignore DL4000 --ignore DL4001
 hadolint_container := hadolint/hadolint:latest
-pwd := $(shell pwd)
-export BUNDLE_PATH = $(pwd)/.bundle/gems
-export BUNDLE_BIN = $(pwd)/.bundle/bin
-export GEMFILE = $(pwd)/Gemfile
+export BUNDLE_PATH = $(PWD)/.bundle/gems
+export BUNDLE_BIN = $(PWD)/.bundle/bin
+export GEMFILE = $(PWD)/Gemfile
 
-version := $(shell command grep VERSION ../lib/r10k/version.rb | awk '{print $$3}' | sed "s/'//g")
-dockerfile := Dockerfile
+ifeq ($(IS_RELEASE),true)
+	VERSION ?= $(shell echo $(git_describe) | sed 's/-.*//')
+	LATEST_VERSION ?= latest
+	dockerfile := release.Dockerfile
+	dockerfile_context := r10k
+else
+	VERSION ?= edge
+	IS_LATEST := false
+	dockerfile := Dockerfile
+	dockerfile_context := $(PWD)/..
+endif
 
 prep:
 	@git fetch --unshallow 2> /dev/null ||:
@@ -27,37 +35,37 @@ else
 endif
 
 build: prep
-	@docker build \
+	docker build \
 		--pull \
 		--build-arg vcs_ref=$(vcs_ref) \
 		--build-arg build_date=$(build_date) \
-		--build-arg version=$(version) \
+		--build-arg version=$(VERSION) \
 		--build-arg pupperware_analytics_stream=$(PUPPERWARE_ANALYTICS_STREAM) \
 		--file r10k/$(dockerfile) \
-		--tag $(NAMESPACE)/r10k:$(version) $(pwd)/..
+		--tag $(NAMESPACE)/r10k:$(VERSION) $(dockerfile_context)
 ifeq ($(IS_LATEST),true)
-	@docker tag $(NAMESPACE)/r10k:$(version) puppet/r10k:latest
+	@docker tag $(NAMESPACE)/r10k:$(VERSION) puppet/r10k:$(LATEST_VERSION)
 endif
 
 test: prep
 	@bundle install --path $$BUNDLE_PATH --gemfile $$GEMFILE --with test
 	@bundle update
-	@PUPPET_TEST_DOCKER_IMAGE=$(NAMESPACE)/r10k:$(version) \
+	@PUPPET_TEST_DOCKER_IMAGE=$(NAMESPACE)/r10k:$(VERSION) \
 		bundle exec --gemfile $$GEMFILE \
 		rspec spec
 
 push-image: prep
-	@docker push $(NAMESPACE)/r10k:$(version)
+	@docker push $(NAMESPACE)/r10k:$(VERSION)
 ifeq ($(IS_LATEST),true)
-	@docker push $(NAMESPACE)/r10k:latest
+	@docker push $(NAMESPACE)/r10k:$(LATEST_VERSION)
 endif
 
 push-readme:
 	@docker pull sheogorath/readme-to-dockerhub
 	@docker run --rm \
 		-v $(PWD)/README.md:/data/README.md \
-		-e DOCKERHUB_USERNAME="$(DISTELLI_DOCKER_USERNAME)" \
-		-e DOCKERHUB_PASSWORD="$(DISTELLI_DOCKER_PW)" \
+		-e DOCKERHUB_USERNAME="$(DOCKERHUB_USERNAME)" \
+		-e DOCKERHUB_PASSWORD="$(DOCKERHUB_PASSWORD)" \
 		-e DOCKERHUB_REPO_PREFIX=puppet \
 		-e DOCKERHUB_REPO_NAME=r10k \
 		sheogorath/readme-to-dockerhub

data/docker/r10k/Dockerfile

@@ -1,7 +1,7 @@
 FROM alpine:3.9 as build
 
-RUN apk add --no-cache ruby git
-RUN mkdir /workspace
+RUN apk add --no-cache ruby git && \
+    mkdir /workspace
 WORKDIR /workspace
 COPY . /workspace
 RUN gem build r10k.gemspec && \
@@ -15,32 +15,40 @@ ARG version="3.1.0"
 # Used by entrypoint to submit metrics to Google Analytics.
 # Published images should use "production" for this build_arg.
 ARG pupperware_analytics_stream="dev"
-ENV PUPPERWARE_ANALYTICS_STREAM="$pupperware_analytics_stream"
-
-ENV R10K_VERSION="$version"
 
 LABEL org.label-schema.maintainer="Puppet Release Team <release@puppet.com>" \
       org.label-schema.vendor="Puppet" \
       org.label-schema.url="https://github.com/puppetlabs/r10k" \
       org.label-schema.name="r10k" \
       org.label-schema.license="Apache-2.0" \
-      org.label-schema.version="$R10K_VERSION" \
       org.label-schema.vcs-url="https://github.com/puppetlabs/r10k" \
-      org.label-schema.vcs-ref="$vcs_ref" \
-      org.label-schema.build-date="$build_date" \
       org.label-schema.schema-version="1.0" \
       org.label-schema.dockerfile="/Dockerfile"
 
-RUN apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-dev make gcc musl-dev
-COPY --from=build /workspace/r10k.gem /
-RUN gem install --no-doc r10k.gem json etc && \
-    rm -f r10k.gem
-
-COPY docker/r10k/docker-entrypoint.sh /
-RUN chmod +x /docker-entrypoint.sh
+COPY docker/r10k/adduser.sh docker/r10k/docker-entrypoint.sh /
 COPY docker/r10k/docker-entrypoint.d /docker-entrypoint.d
 
 ENTRYPOINT ["/docker-entrypoint.sh"]
 CMD ["help"]
 
+# dyanmic LABELs and ENV vars placed lower for the sake of Docker layer caching
+ENV PUPPERWARE_ANALYTICS_STREAM="$pupperware_analytics_stream"
+
+LABEL org.label-schema.version="$version" \
+      org.label-schema.vcs-ref="$vcs_ref" \
+      org.label-schema.build-date="$build_date"
+
+COPY --from=build /workspace/r10k.gem /
+RUN chmod a+x /adduser.sh && \
+# Add a puppet user to run r10k as for consistency with puppetserver
+    /adduser.sh && \
+    chmod +x /docker-entrypoint.sh && \
+    chown -R puppet: /docker-entrypoint.d /docker-entrypoint.sh && \
+    apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-dev make gcc musl-dev && \
+    gem install --no-doc /r10k.gem json etc && \
+    rm -f /r10k.gem
+
+USER puppet
+WORKDIR /home/puppet
+
 COPY docker/r10k/Dockerfile /

data/docker/r10k/adduser.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+getent_string="$(getent group | grep -e ':999$')"
+exit_code=$?
+
+if [ "$exit_code" = '0' ]; then
+  group="$(echo $getent_string | cut -d ':' -f1)"
+else
+  addgroup -g 999 puppet
+  group='puppet'
+fi
+
+adduser -G $group -D -u 999 puppet

data/docker/r10k/docker-entrypoint.d/10-analytics.sh

@@ -11,7 +11,7 @@ tid=UA-132486246-5
 # Application Name
 an=r10k
 # Application Version
-av=$R10K_VERSION
+av=$(r10k version | cut -d ' ' -f 2)
 # Anonymous Client ID
 _file=/var/tmp/pwclientid
 cid=$(cat $_file 2>/dev/null || (cat /proc/sys/kernel/random/uuid | tee $_file))

data/docker/r10k/release.Dockerfile

@@ -0,0 +1,36 @@
+FROM alpine:3.9
+
+ARG vcs_ref
+ARG build_date
+ARG version="3.1.0"
+# Used by entrypoint to submit metrics to Google Analytics.
+# Published images should use "production" for this build_arg.
+ARG pupperware_analytics_stream="dev"
+
+LABEL org.label-schema.maintainer="Puppet Release Team <release@puppet.com>" \
+      org.label-schema.vendor="Puppet" \
+      org.label-schema.url="https://github.com/puppetlabs/r10k" \
+      org.label-schema.name="r10k" \
+      org.label-schema.license="Apache-2.0" \
+      org.label-schema.vcs-url="https://github.com/puppetlabs/r10k" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.dockerfile="/release.Dockerfile"
+
+COPY docker-entrypoint.sh /
+COPY docker-entrypoint.d /docker-entrypoint.d
+
+ENTRYPOINT ["/docker-entrypoint.sh"]
+CMD ["help"]
+
+# dyanmic LABELs and ENV vars placed lower for the sake of Docker layer caching
+ENV PUPPERWARE_ANALYTICS_STREAM="$pupperware_analytics_stream"
+
+LABEL org.label-schema.version="$version" \
+      org.label-schema.vcs-ref="$vcs_ref" \
+      org.label-schema.build-date="$build_date"
+
+RUN chmod +x /docker-entrypoint.sh && \
+    apk add --no-cache ruby openssh-client git ruby-rugged curl ruby-dev make gcc musl-dev && \
+    gem install --no-doc r10k:"$version" json etc
+
+COPY release.Dockerfile /