Cherry pick commits for v0.1.1 release (#695)

* pkg/scaffold: remove TODO for metrics port (#679)

* pkg/scaffold: fix hardcoded crd version (#690)

Have CRD and CR examples match, so examples work
for new users.

Fixes #689

* Release versioning (#684)

* release.sh: fix TOML_TMPL_FILE path

* doc/release-versioning.md: update release versioning doc

* pkg/scaffold/gopkgtoml,version: update branch to v0.1.x

Author: AlexNPavel

doc/release-versioning.md

@@ -24,8 +24,8 @@ Minor version changes will not break compatibility between the previous minor ve
 We expect to release patches for minor releases, so we create a patch trunk to branch from. The naming convention follows "v2.1.x", where the major version is 2, minor is 1, and "x" is a patch version placeholder.
 
 ```bash
-$ MAV_MIN_VER="v${MAJOR_VERSION}.${NEW_MINOR_VERSION}"
-$ git checkout -b "${MAJ_MIN_VER}.x" tags/"v${MAJ_MIN_VER}.0"
+$ export MAJ_MIN_VER="${MAJOR_VERSION}.${NEW_MINOR_VERSION}"
+$ git checkout -b "v${MAJ_MIN_VER}.x" tags/"v${MAJ_MIN_VER}.0"
 $ git push [email protected]:operator-framework/operator-sdk.git "v${MAJ_MIN_VER}.x"
 ```
 
@@ -116,9 +116,64 @@ Patch releases should have the following format:
 ...
 ```
 
+# Release Signing
+
+When a new release is created, the tag for the commit it signed with a maintainer's gpg key and
+the binaries for the release are also signed by the same key. All keys used by maintainers will
+be available via public gpg keyservers such as [pgp.mit.edu][mit-keyserver]. To verify a git
+tag signature, use this command:
+
+```sh
+$ git verify-tag --verbose ${TAG_NAME}
+```
+
+To verify a release binary using the provided asc files, place the binary and corresponding asc
+file into the same directory and use the corresponding command:
+
+```sh
+# macOS
+$ gpg --verify operator-sdk-${RELEASE_VERSION}-x86_64-apple-darwin.asc
+# GNU/Linux
+$ gpg --verify operator-sdk-${RELEASE_VERSION}-x86_64-linux-gnu.asc
+```
+
+If you do not have the maintainers public key on your machine, you will get an error message similar
+to this:
+
+```sh
+$ git verify-tag ${TAG_NAME}
+gpg: Signature made Wed 31 Oct 2018 02:57:31 PM PDT
+gpg:                using RSA key 4AEE18F83AFDEB23
+gpg: Can't check signature: public key not found
+```
+
+To download the key, use this command, replacing `${KEY_ID}` with the RSA key string provided in the output
+of the previous command:
+
+```sh
+$ gpg --recv-key ${KEY_ID}
+```
+
+Now you should be able to verify the tags and/or binaries
+
+## For maintainers
+For new maintainers who have not done a release and do not have their gpg key on a public
+keyserver, you must add your public key to a keyserver. To do this, output your armored
+public key using this command:
+
+```sh
+$ gpg --armor --export ${GPG_EMAIL} > mykey.asc
+```
+
+Then, copy and paste the content of the outputted file into the `Submit a key` section on
+the [MIT PGP Public Key Server][mit-keyserver] or any other public keyserver that forwards
+the key to other public keyservers. Once that is done, other people can download your public
+key and you are ready to sign releases.
+
 [link-semver]:https://semver.org/
 [link-github-milestones]: https://help.github.com/articles/about-milestones/
 [doc-maintainers]:../MAINTAINERS
 [link-github-gpg-key-upload]:https://github.com/settings/keys
 [link-git-config-gpg-key]:https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work
-[doc-kube-version]:https://github.com/operator-framework/operator-sdk#prerequisites
+[doc-kube-version]:https://github.com/operator-framework/operator-sdk#prerequisites
+[mit-keyserver]:https://pgp.mit.edu

pkg/scaffold/cmd.go

@@ -67,9 +67,6 @@ func main() {
 		log.Fatalf("failed to get watch namespace: %v", err)
 	}
 
-	// TODO: Expose metrics port after SDK uses controller-runtime's dynamic client
-	// sdk.ExposeMetricsPort()
-
 	// Get a config to talk to the apiserver
 	cfg, err := config.GetConfig()
 	if err != nil {

pkg/scaffold/cmd_test.go

@@ -63,9 +63,6 @@ func main() {
 		log.Fatalf("failed to get watch namespace: %v", err)
 	}
 
-	// TODO: Expose metrics port after SDK uses controller-runtime's dynamic client
-	// sdk.ExposeMetricsPort()
-
 	// Get a config to talk to the apiserver
 	cfg, err := config.GetConfig()
 	if err != nil {

pkg/scaffold/crd.go

@@ -55,5 +55,5 @@ spec:
     plural: {{ .Resource.Resource }}
     singular: {{ .Resource.LowerKind }}
   scope: Namespaced
-  version: v1alpha1
+  version: {{ .Resource.Version }}
 `

pkg/scaffold/gopkgtoml.go

@@ -76,8 +76,8 @@ required = [
 [[constraint]]
   name = "github.com/operator-framework/operator-sdk"
   # The version rule is used for a specific release and the master branch for in between releases.
-  # branch = "master" #osdk_branch_annotation
-  version = "=v0.1.0" #osdk_version_annotation
+  branch = "v0.1.x" #osdk_branch_annotation
+  # version = "=v0.1.0" #osdk_version_annotation
 
 [prune]
   go-tests = true

pkg/scaffold/gopkgtoml_test.go

@@ -75,8 +75,8 @@ required = [
 [[constraint]]
   name = "github.com/operator-framework/operator-sdk"
   # The version rule is used for a specific release and the master branch for in between releases.
-  # branch = "master" #osdk_branch_annotation
-  version = "=v0.1.0" #osdk_version_annotation
+  branch = "v0.1.x" #osdk_branch_annotation
+  # version = "=v0.1.0" #osdk_version_annotation
 
 [prune]
   go-tests = true

release.sh

@@ -26,7 +26,7 @@ fi
 # Detect whether versions in code were updated.
 CURR_VER="$(git describe --dirty --tags)"
 VER_FILE="version/version.go"
-TOML_TMPL_FILE="pkg/generator/templates.go"
+TOML_TMPL_FILE="pkg/scaffold/gopkgtoml.go"
 CURR_VER_VER_FILE="$(sed -nr 's/Version = "(.+)"/\1/p' "$VER_FILE" | tr -d '\s\t\n')"
 CURR_VER_TMPL_FILE="$(sed -nr 's/.*".*v(.+)".*#osdk_version_annotation/v\1/p' "$TOML_TMPL_FILE" | tr -d '\s\t\n')"
 if [ "$VER" != "$CURR_VER_VER_FILE" ] \

version/version.go

@@ -15,5 +15,5 @@
 package version
 
 var (
-	Version = "v0.1.0"
+	Version = "v0.1.0+git"
 )