Move examples into example-bundles repository (getporter#2015)

* Move examples into example-bundles repository

Remove the example bundles in /examples/ and point to the relocated
example bundles in https://github.com/getporter/example-bundles

Signed-off-by: Carolyn Van Slyck <[email protected]>

* Remove examples from the CI pipeline

Now that the examples are moved into example-bundles, remove targets
for building and publishing example bundles from Porter's build.

Signed-off-by: Carolyn Van Slyck <[email protected]>

* Copy exec-outputs as a test bundle

Signed-off-by: Carolyn Van Slyck <[email protected]>

* Update references to moved examples

The example bundles were moved to github.com/getporter/examples, and are
now published to ghcr.io/getporter/examples/NAME. The version number of
most bundles was bumped as well to avoid confusing with existing
bundles.

Signed-off-by: Carolyn Van Slyck <[email protected]>

Author: carolynvs

CONTRIBUTING.md

@@ -446,7 +446,7 @@ It can be very helpful when figuring out why a command failed because you can se
 In development, you can use the [otel-jaeger bundle] to set up a development instance of Jaeger, which gives you a nice website to see each command run.
 
 ```
-porter install --reference carolynvs/otel-jaeger:v0.1.0 --allow-docker-host-access
+porter install --reference ghcr.io/getporter/examples/otel-jaeger:v0.1.0 --allow-docker-host-access
 ```
 
 Then to turn on tracing in Porter, set the following environment variables.
@@ -472,7 +472,7 @@ Next run a Porter command to generate some trace data, such as `porter list`.
 Then go to the Jaeger website to see your data: http://localhost:16686.
 On the Jaeger dashboard, select "porter" from the service drop down, and click "Find Traces".
 
-[otel-jaeger bundle]: https://github.com/getporter/example-bundles/tree/main/otel-jaeger
+[otel-jaeger bundle]: https://getporter.org/examples/src/otel-jaeger
 
 ## Command Documentation
 

Makefile

@@ -74,64 +74,6 @@ define all-bundles
 	done
 endef
 
-EXAMPLES_DIR := examples
-
-.PHONY: lint-examples
-lint-examples:
-ifndef BUNDLE
-	$(call all-bundles,$(EXAMPLES_DIR),lint-examples)
-else
-	cd $(EXAMPLES_DIR)/$(BUNDLE) && $(LOCAL_PORTER) lint
-endif
-
-.PHONY: build-examples
-build-examples:
-ifndef BUNDLE
-	$(call all-bundles,$(EXAMPLES_DIR),build-examples)
-else
-	cd $(EXAMPLES_DIR)/$(BUNDLE) && $(LOCAL_PORTER) build --debug
-endif
-
-.PHONY: publish-examples
-publish-examples:
-ifndef BUNDLE
-	$(call all-bundles,$(EXAMPLES_DIR),publish-examples)
-else
-	cd $(EXAMPLES_DIR)/$(BUNDLE) && $(LOCAL_PORTER) publish --registry $(PORTER_REGISTRY) --debug
-endif
-
-SCHEMA_VERSION     := cnab-core-1.0.1
-BUNDLE_SCHEMA      := bundle.schema.json
-DEFINITIONS_SCHEMA := definitions.schema.json
-
-define fetch-schema
-	@curl -L --fail --silent --show-error -o /tmp/$(1) \
-		https://cnab.io/schema/$(SCHEMA_VERSION)/$(1)
-endef
-
-fetch-schemas: fetch-bundle-schema fetch-definitions-schema
-
-fetch-bundle-schema:
-	$(call fetch-schema,$(BUNDLE_SCHEMA))
-
-fetch-definitions-schema:
-	$(call fetch-schema,$(DEFINITIONS_SCHEMA))
-
-HAS_AJV := $(shell command -v ajv)
-ajv:
-ifndef HAS_AJV
-	npm install -g [email protected]
-endif
-
-.PHONY: validate-bundle
-validate-examples: fetch-schemas ajv
-ifndef BUNDLE
-	$(call all-bundles,$(EXAMPLES_DIR),validate-examples)
-else
-	cd $(EXAMPLES_DIR)/$(BUNDLE) && \
-		ajv test -s /tmp/$(BUNDLE_SCHEMA) -r /tmp/$(DEFINITIONS_SCHEMA) -d .cnab/bundle.json --valid
-endif
-
 install:
 	go run mage.go install
 

build/azure-pipelines.canary.yml

@@ -14,14 +14,10 @@ parameters:
   - name: skipTests
     type: boolean
     default: false
-  - name: publishExamples
-    type: boolean
-    default: false
 
 extends:
   template: azure-pipelines.release-template.yml
   parameters:
     skipTests: ${{parameters.skipTests}}
     shouldPublish: ${{parameters.shouldPublish}}
-    publishExamples: ${{parameters.publishExamples}}
     registry: ghcr.io/getporter

build/azure-pipelines.pr-automatic.yml

@@ -13,11 +13,6 @@ pool:
 variables:
   GOVERSION: "1.18"
 
-parameters:
-  - name: buildExamples
-    type: boolean
-    default: false
-
 stages:
   - stage: Setup
     jobs:
@@ -77,27 +72,6 @@ stages:
             displayName: "Configure Agent"
           - bash: mage TestUnit
             displayName: "Unit Test"
-      - job: validate_examples
-        displayName: "Validate Examples"
-        dependsOn: build
-        steps:
-          - task: DownloadPipelineArtifact@2
-            displayName: "Download Native Porter Binaries"
-            inputs:
-              source: current
-              artifact: build-bin
-              path: bin
-          - task: GoTool@0
-            displayName: "Set Go Version"
-            inputs:
-              version: "$(GOVERSION)"
-          - script: go run mage.go SetBinExecutable
-            displayName: "Setup Bin"
-          - bash: make lint-examples
-            displayName: "Lint Examples"
-          - bash: make build-examples
-            displayName: "Build Examples"
-            condition: ${{parameters.buildExamples}}
       - job: build_docker
         dependsOn: xbuild
         steps:

build/azure-pipelines.release-template.yml

@@ -17,9 +17,6 @@ parameters:
   - name: skipTests
     type: boolean
     default: false
-  - name: publishExamples
-    type: boolean
-    default: true
 
 stages:
   - stage: Validate
@@ -180,35 +177,3 @@ stages:
               command: login
           - script: PORTER_REGISTRY=${{parameters.registry}} mage PublishImages
             displayName: "Publish Docker Images to ${{parameters.registry}}"
-
-      - job: publish_example_bundles
-        displayName: "Publish Example Bundles"
-        condition: and(succeeded(), ${{ parameters.publishExamples }})
-        pool:
-          vmImage: ${{variables.vmImage}}
-        steps:
-          - task: GoTool@0
-            displayName: "Set Go Version"
-            inputs:
-              version: ${{parameters.goVersion}}
-          - task: DownloadPipelineArtifact@2
-            displayName: "Download Native Porter Binaries"
-            inputs:
-              source: current
-              artifact: build-bin
-              path: bin
-          - script: go run mage.go ConfigureAgent SetBinExecutable
-            displayName: "Setup Bin"
-          - bash: |
-              set -e
-              sudo make ajv
-              make build-examples validate-examples
-            displayName: "Build Example Bundles"
-          - task: Docker@1
-            displayName: Docker Login
-            inputs:
-              containerRegistryType: Container Registry
-              dockerRegistryEndpoint: ${{parameters.registry}} # Log in with the saved credentials for the destination registry
-              command: login
-          - script: PORTER_REGISTRY=${{parameters.registry}} make publish-examples
-            displayName: "Publish Example Bundles"

build/azure-pipelines.test-release.yml

@@ -8,14 +8,10 @@ parameters:
   - name: skipTests
     type: boolean
     default: true
-  - name: publishExamples
-    type: boolean
-    default: false
 
 extends:
   template: azure-pipelines.release-template.yml
   parameters:
       skipTests: ${{ parameters.skipTests }}
       shouldPublish: ${{ parameters.shouldPublish }}
       registry: ghcr.io/getporter/test
-      publishExamples: ${{ parameters.publishExamples }}

cmd/porter/bundle.go

@@ -140,8 +140,8 @@ Once a bundle has been successfully installed, the install action cannot be repe
 Porter uses the Docker driver as the default runtime for executing a bundle's invocation image, but an alternate driver may be supplied via '--driver/-d' or the PORTER_RUNTIME_DRIVER environment variable.
 For example, the 'debug' driver may be specified, which simply logs the info given to it and then exits.`,
 		Example: `  porter bundle install
-  porter bundle install MyAppFromReference --reference getporter/kubernetes:v0.1.0 --namespace dev
-  porter bundle install --reference localhost:5000/getporter/kubernetes:v0.1.0 --insecure-registry --force
+  porter bundle install MyAppFromReference --reference ghcr.io/getporter/examples/kubernetes:v0.2.0 --namespace dev
+  porter bundle install --reference localhost:5000/ghcr.io/getporter/examples/kubernetes:v0.2.0 --insecure-registry --force
   porter bundle install MyAppInDev --file myapp/bundle.json
   porter bundle install --parameter-set azure --param test-mode=true --param header-color=blue
   porter bundle install --cred azure --cred kubernetes
@@ -198,8 +198,8 @@ The first argument is the installation name to upgrade. This defaults to the nam
 Porter uses the Docker driver as the default runtime for executing a bundle's invocation image, but an alternate driver may be supplied via '--driver/-d' or the PORTER_RUNTIME_DRIVER environment variable.
 For example, the 'debug' driver may be specified, which simply logs the info given to it and then exits.`,
 		Example: `  porter bundle upgrade --version 0.2.0
-  porter bundle upgrade --reference getporter/kubernetes:v0.1.0
-  porter bundle upgrade --reference localhost:5000/getporter/kubernetes:v0.1.0 --insecure-registry --force
+  porter bundle upgrade --reference ghcr.io/getporter/examples/kubernetes:v0.2.0
+  porter bundle upgrade --reference localhost:5000/ghcr.io/getporter/examples/kubernetes:v0.2.0 --insecure-registry --force
   porter bundle upgrade MyAppInDev --file myapp/bundle.json
   porter bundle upgrade --parameter-set azure --param test-mode=true --param header-color=blue
   porter bundle upgrade --cred azure --cred kubernetes
@@ -255,8 +255,8 @@ The first argument is the installation name upon which to invoke the action. Thi
 Porter uses the Docker driver as the default runtime for executing a bundle's invocation image, but an alternate driver may be supplied via '--driver/-d' or the PORTER_RUNTIME_DRIVER environment variable.
 For example, the 'debug' driver may be specified, which simply logs the info given to it and then exits.`,
 		Example: `  porter bundle invoke --action ACTION
-  porter bundle invoke --reference getporter/kubernetes:v0.1.0
-  porter bundle invoke --reference localhost:5000/getporter/kubernetes:v0.1.0 --insecure-registry --force
+  porter bundle invoke --reference ghcr.io/getporter/examples/kubernetes:v0.2.0
+  porter bundle invoke --reference localhost:5000/ghcr.io/getporter/examples/kubernetes:v0.2.0 --insecure-registry --force
   porter bundle invoke --action ACTION MyAppInDev --file myapp/bundle.json
   porter bundle invoke --action ACTION  --parameter-set azure --param test-mode=true --param header-color=blue
   porter bundle invoke --action ACTION --cred azure --cred kubernetes
@@ -312,8 +312,8 @@ The first argument is the installation name to uninstall. This defaults to the n
 Porter uses the Docker driver as the default runtime for executing a bundle's invocation image, but an alternate driver may be supplied via '--driver/-d'' or the PORTER_RUNTIME_DRIVER environment variable.
 For example, the 'debug' driver may be specified, which simply logs the info given to it and then exits.`,
 		Example: `  porter bundle uninstall
-  porter bundle uninstall --reference getporter/kubernetes:v0.1.0
-  porter bundle uninstall --reference localhost:5000/getporter/kubernetes:v0.1.0 --insecure-registry --force
+  porter bundle uninstall --reference ghcr.io/getporter/examples/kubernetes:v0.2.0
+  porter bundle uninstall --reference localhost:5000/ghcr.io/getporter/examples/kubernetes:v0.2.0 --insecure-registry --force
   porter bundle uninstall MyAppInDev --file myapp/bundle.json
   porter bundle uninstall --parameter-set azure --param test-mode=true --param header-color=blue
   porter bundle uninstall --cred azure --cred kubernetes
@@ -406,8 +406,8 @@ func buildBundleArchiveCommand(p *porter.Porter) *cobra.Command {
 		Use:   "archive FILENAME --reference PUBLISHED_BUNDLE",
 		Short: "Archive a bundle from a reference",
 		Long:  "Archives a bundle by generating a gzipped tar archive containing the bundle, invocation image and any referenced images.",
-		Example: `  porter bundle archive mybun.tgz --reference getporter/porter-hello:v0.1.0
-  porter bundle archive mybun.tgz --reference localhost:5000/getporter/porter-hello:v0.1.0 --force
+		Example: `  porter bundle archive mybun.tgz --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
+  porter bundle archive mybun.tgz --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --force
 `,
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.Validate(cmd.Context(), args, p)

cmd/porter/bundle_test.go

@@ -17,8 +17,8 @@ func TestValidateInstallCommand(t *testing.T) {
 		args      string
 		wantError string
 	}{
-		{"no args", "install -r getporter/porter-hello:v0.1.1", ""},
-		{"invalid param", "install --param A:B -r getporter/porter-hello:v0.1.1", "invalid parameter (A:B), must be in name=value format"},
+		{"no args", "install -r ghcr.io/getporter/examples/porter-hello:v0.2.0", ""},
+		{"invalid param", "install --param A:B -r ghcr.io/getporter/examples/porter-hello:v0.2.0", "invalid parameter (A:B), must be in name=value format"},
 	}
 
 	for _, tc := range testcases {

cmd/porter/copy.go

@@ -19,8 +19,8 @@ Destination can be either a registry, a registry/repository, or a fully tagged b
 If the source bundle is a digest reference, destination must be a tagged reference.
 `,
 		Example: `  porter bundle copy
-  porter bundle copy --source getporter/porter-hello:v0.1.0 --destination portersh
-  porter bundle copy --source getporter/porter-hello:v0.1.0 --destination portersh --insecure-registry
+  porter bundle copy --source ghcr.io/getporter/examples/porter-hello:v0.2.0 --destination portersh
+  porter bundle copy --source ghcr.io/getporter/examples/porter-hello:v0.2.0 --destination portersh --insecure-registry
 		  `,
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			return opts.Validate()

cmd/porter/explain.go

@@ -14,8 +14,8 @@ func buildBundleExplainCommand(p *porter.Porter) *cobra.Command {
 		Short: "Explain a bundle",
 		Long:  "Explain how to use a bundle by printing the parameters, credentials, outputs, actions.",
 		Example: `  porter bundle explain
-  porter bundle explain --reference getporter/porter-hello:v0.1.0
-  porter bundle explain --reference localhost:5000/getporter/porter-hello:v0.1.0 --insecure-registry --force
+  porter bundle explain --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
+  porter bundle explain --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --insecure-registry --force
   porter bundle explain --file another/porter.yaml
   porter bundle explain --cnab-file some/bundle.json
   porter bundle explain --action install

cmd/porter/inspect.go

@@ -17,8 +17,8 @@ If you would like more information about the bundle, the porter explain command
 like parameters, credentials, outputs and custom actions available.
 `,
 		Example: `  porter bundle inspect
-  porter bundle inspect --reference getporter/porter-hello:v0.1.0
-  porter bundle inspect --reference localhost:5000/getporter/porter-hello:v0.1.0 --insecure-registry --force
+  porter bundle inspect --reference ghcr.io/getporter/examples/porter-hello:v0.2.0
+  porter bundle inspect --reference localhost:5000/ghcr.io/getporter/examples/porter-hello:v0.2.0 --insecure-registry --force
   porter bundle inspect --file another/porter.yaml
   porter bundle inspect --cnab-file some/bundle.json
 		  `,

docs/content/administrators/diagnostics.md

@@ -42,4 +42,4 @@ See [Telemetry Settings][telemetry] for all the supported configuration settings
 [Log Settings]: /configuration/#logs
 [structured-logs]: /configuration/#structured-logs
 [OpenTelemetry]: https://opentelemetry.io
-[otel-jaeger bundle]: https://github.com/getporter/example-bundles/tree/main/otel-jaeger
+[otel-jaeger bundle]: /examples/src/otel-jaeger

docs/content/author-bundles.md

@@ -26,7 +26,7 @@ The manifest is made up of multiple components. See the [Manifest File Format] f
 * [Required](#required)
 * [Generated Files](#generated-files)
 
-We have full [examples](https://porter.sh/src/examples) of Porter manifests in the Porter repository.
+We have full [examples](https://github.com/getporter/examples) of Porter manifests in the Porter repository.
 
 [templates]: /authors/templates/
 [Manifest File Format]: /reference/file-formats/#manifest
@@ -55,12 +55,10 @@ maintainers:
 * `description`: A description of the bundle
 * `version`: The version of the bundle, uses [semver](https://semver.org). A leading v prefix may optionally be used.
 * `registry`: The registry to use for publishing the bundle. The format is `REGISTRY_HOST/ORG`.
-    Both the final bundle reference and invocation image name will be based on this value.
+    The final bundle reference will be based on this value.
     For example, if the bundle name is `porter-hello`, registry is `getporter` and the version is `0.1.0`,
-    the bundle reference will be `getporter/porter-hello:v0.1.0` and the invocation image name will be `getporter/porter-hello-installer:v0.1.0`
+    the bundle reference will be `ghcr.io/getporter/examples/porter-hello:v0.2.0`.
 * `reference`: OPTIONAL. The bundle reference, taking precedence over any values set for the `registry`, `name` fields. The format is `REGISTRY_HOST/ORG/NAME`.  The recommended pattern is to let the Docker tag be auto-derived from the `version` field.  However, a full reference with a Docker tag included may also be specified.
-   The invocation image name will also be based on this value when set. For example, if the `reference` is
-   `getporter/porter-hello`, then the final invocation image name will be `getporter/porter-hello-installer:v0.1.0`. 
 
    When the version is used to default the tag, and it contains a plus sign (+), the plus sign is replaced with an underscore because while + is a valid semver delimiter for the build metadata, it is not an allowed character in a tag.
 * `dockerfile`: OPTIONAL. The relative path to a Dockerfile to use as a template during `porter build`. 

docs/content/best-practices/exec-mixin.md

@@ -75,7 +75,7 @@ install:
     - generate-users
 ```
 
-[exec-outputs]: https://porter.sh/src/examples/exec-outputs/
+[exec-outputs]: /examples/src/exec-outputs/
 
 ## Quoting, Escaping, Bash and YAML
 

docs/content/best-practices/gke.md

@@ -6,9 +6,9 @@ description: How to connect to a GKE cluster inside a Porter bundle.
 GKE cluster authentication requires more than just a kubeconfig, it also needs a
 service account configured.
 
-See the [GKE example][example] for a full working example bundle.
+See [ghcr.io/getporter/examples/gke][example] for a full working example bundle.
 
-[example]: https://porter.sh/src/examples/gke-example
+[example]: /examples/src/gke
 
 1. [Generate a kubeconfig](#generate-a-kubeconfig).
 1. [Create a service account](#create-a-service-account).

docs/content/blog/migrate-from-docker-app.md

@@ -135,7 +135,7 @@ We will use the [docker-compose mixin] to migrate an existing Docker App to Port
 
 1. So far we have been working inside the "developer iteration loop", where you can edit the bundle on your local filesystem and deploy it to your developer environment to test it.
     Once the bundle is stable, the next step is to publish it to an OCI registry so that others can install your bundle using its reference.
-    All of the porter commands accept a flag, \--reference, for example `porter install --reference getporter/porter-hello:v0.1.1` so that you do not need to distribute the bundle files themselves.
+    All of the porter commands accept a flag, \--reference, for example `porter install --reference ghcr.io/getporter/examples/porter-hello:v0.2` so that you do not need to distribute the bundle files themselves.
 
 1. When you are ready to share your bundle with others, select which OCI registry where you will host the bundle, for example, `ghcr.io/getporter` or on Docker Hub under your username `carolynvs`.
     Edit your porter.yaml and set the registry field to the destination registry.
@@ -144,7 +144,7 @@ We will use the [docker-compose mixin] to migrate an existing Docker App to Port
     name: my-docker-app
     version: 0.1.0
     description: My amazing docker app
-    registry: ghcr.io/getporter
+    registry: carolynvs
     ```
 
 1. Publish your bundle to the destination registry with `porter publish`.