getporter / examples Goto Github PK

View Code? Open in Web Editor NEW

14.0 14.0 7.0 300 KB

Example Porter bundles

Home Page: https://porter.sh/examples/

License: Apache License 2.0

Shell 25.24% Mustache 8.83% HCL 13.10% Dockerfile 4.45% Go 39.41% Smarty 8.97%

cnab hacktoberfest porter

examples's People

Contributors

Stargazers

Watchers

Forkers

asalbers vdice vinozzz carolynvs matthewcriswell schristoff zhilyaev

examples's Issues

(bug) Assign Pull Request to Project is broken

When running this workflow we are consistently getting this error.

/usr/bin/docker run --name bbcdfaeca0eb84ff2b3ba811ad1f2086c_346d13 --label 94351b --workdir /github/workspace --rm -e "MY_GITHUB_TOKEN" -e "INPUT_PROJECT" -e "INPUT_COLUMN_NAME" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_ENVIRONMENT" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/examples/examples":"/github/workspace" 94351b:bcdfaeca0eb84ff2b3ba811ad1f2086c  "https://github.com/orgs/getporter/projects/1" "In Progress"
jq: error (at <stdin>:4): Cannot index string with string "html_url"
No project was found.
jq: error (at <stdin>:4): Cannot index string with string "name"
Column name '' is not found.

Expected Behavior

Let's update this to point to the proper project board and put all new issues in new so we can triage them :)

Document how to add a new example

Explain that when you add a new example how (with pictures, it's hard to find!) to give the getporter bot permission to push the example bundle and invocation image to the docker hub registry.

Publish failed with interface conversion error

The most recent merge to main wasn't able to be published properly.

https://github.com/getporter/examples/runs/6691497996?check_suite_focus=true

TRUNCATED
==========================
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/private-assets:v0.1.0
Skipping publish for example bundle: plugins-tutorial. The bundle is already published to ghcr.io/getporter/examples/plugins-tutorial:v0.2.0.

==========================
Skipping publish for example bundle: private-assets. The bundle is already published to ghcr.io/getporter/examples/private-assets:v0.1.0.
Error: interface conversion: interface {} is nil, not string

==========================
Error: Process completed with exit code 1.

Fix wrong description on GKE example and link of Kubernetes example

Describe the bug

The README for GKE on the example directory currently has the description for Kubernetes example instead.
The link for GKE best practice on Kubernetes example README points to localhost.

To Reproduce

Documentation.

Expected behavior

README for GKE contains description for GKE example.
Link for GKE best practice on KUbernetes example contains appropriate link.

Porter Command and Output

Documentation.

Version

Make the outputs for sensitive data bundle more clear

Right now the output for the sensitive data bundle is name, which was originally a non-sensitive output. Since we use "name" for both the non-sensitive parameter and the sensitive output, it can be confusing for people. I spoke with @VinozzZ and we decided that it would be more clear if we changed what the bundle output. Instead of outputing name, we output the original password parameter (which is sensitive) and give the output a unique name like "admin-password".

Explain bundle conventions in the contributing guide

We have some unwritten expectations/requirements for example bundles that should be explained in our CONTRIBUTING.md file:

name, version and registry are required. Do not use reference.
The bundle README.md should provide enough information that someone can copy/paste their way to victory and installing the example bundle. So include any configuration/setup such as required credentials, parameters, or infrastructure (like a cluster). It's okay to link to a doc that explains how to do that stuff, you don't need to repeat it. Also include a "Try it out" section that gives them the install command with all required parameters/flags included.
If the bundle provisions any resources, include a "Cleanup" section that walks them through uninstalling the bundle cleanly so that they aren't billed for any lingering resources.

Setup docker layer caching

It would significantly speed up the build if our github actions cached the docker layers generated during a build. Most bundles won't change very often, so then we only spend time building bundles that actually have changed.

See getporter/porter#2019

Publish example bundle is failing

We need to use the rc1 version of porter to support the latest bundle schema.

Run mage -v Publish
Running target: Publish
Running dependency: PublishExamples
Running dependency: get.porter.sh/magefiles/porter.UseBinForPorterHome
Added /home/runner/work/examples/examples/bin to $PATH
Running dependency: get.porter.sh/magefiles/porter.EnsurePorter
exec: /home/runner/work/examples/examples/bin/porter /home/runner/work/examples/examples/bin/porter --version
Porter client not found at /home/runner/work/examples/examples/bin/porter
Installing porter into /home/runner/work/examples/examples/bin
Downloading https://cdn.porter.sh/v1.0.0-alpha.19/porter-linux-amd64...
exec: /home/runner/work/examples/examples/bin/runtimes/porter-runtime /home/runner/work/examples/examples/bin/runtimes/porter-runtime --version
Porter runtime not found at /home/runner/work/examples/examples/bin/runtimes/porter-runtime
Downloading https://cdn.porter.sh/v1.0.0-alpha.19/porter-linux-amd64...

==========================
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/whalegap:v0.2.0
Skipping publish for example bundle: airgap. The bundle is already published to ghcr.io/getporter/examples/whalegap:v0.2.0.

==========================
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/aks-spring-music:v0.2.0
Skipping publish for example bundle: aks-spring-music. The bundle is already published to ghcr.io/getporter/examples/aks-spring-music:v0.2.0.

==========================
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/hello-keyvault:v0.1.2
Skipping publish for example bundle: azure-keyvault. The bundle is already published to ghcr.io/getporter/examples/hello-keyvault:v0.1.2.

==========================
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/azure-terraform:v2.1.0
exec: /home/runner/work/examples/examples/bin/porter porter publish --registry=ghcr.io/getporter
Publishing example bundle: azure-terraform
warning The schema version is 1.0.0 but the supported schema version is 1.0.0-alpha.1. See https://release-v1.porter.sh/reference/file-formats/#supported-versions for more details.: Invalid schema version
Building bundle ===>
The schema version is 1.0.0 but the supported schema version is 1.0.0-alpha.1. See https://release-v1.porter.sh/reference/file-formats/#supported-versions for more details.: Invalid schema version
exec: /home/runner/work/examples/examples/bin/porter porter explain -r ghcr.io/getporter/examples/azure-wordpress:v0.2.0

getporter.org linked in description is something else now

https://getporter.org/examples is used in the description of this repository.
The URL that previously pointed to Porter's site is now owned by someone else and I guess porter.sh should be used instead.