Adding pagination for installation list result using skip and limit option

.dockerignore

@@ -1,4 +1,5 @@
 *
 
 !bin/dev/porter-linux-amd64
+!bin/dev/agent-linux-amd64
 !bin/mixins/exec/dev/exec-linux-amd64

.github/workflows/close-issues.yaml

@@ -4,16 +4,16 @@
 name: Close Completed Issues
 
 on:
-  pull_request:
+  pull_request_target:
     types: [closed]
     branches:
       - release/*
 
 jobs:
-  closeIssueOnPrMergeTrigger:
+  closeIssue:
     runs-on: ubuntu-latest
     steps:
       - name: Closes issues related to a merged pull request.
-        uses: ldez/gha-mjolnir@v1.0.3
+        uses: ldez/gha-mjolnir@v1.1.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/security-scan.yaml

@@ -0,0 +1,51 @@
+name: Security Scan
+on:
+  # always do a security scan when a change is merged
+  push: {}
+  # Only do a security scan on a PR when there are non-doc changes to save time
+  pull_request_target:
+    paths-ignore:
+      - 'docs/**'
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Get all git history
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+          check-latest: true
+      - name: Set up Cache
+        uses: actions/cache@v3
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+      - name: Configure Agent
+        run: go run mage.go ConfigureAgent
+      - name: Build Porter
+        run: mage -v XBuildAll
+      - name: Build PorterAgent Image
+        run: mage -v BuildImages
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
+      - name: Scan PorterAgent with Trivy
+        uses: aquasecurity/trivy-action@master
+        with:
+          image-ref: "localhost:5000/porter-agent:${{ env.VERSION }}"
+          format: sarif
+          output: trivy-results.sarif
+      - name: Upload Trivy scan results to GitHub Security tab
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: trivy-results.sarif

.gitignore

@@ -1,10 +1,13 @@
 /docs/public/
+/docs/content/operator
+/docs/sources/
 /bin
 /porter
-*-packr.go
 .DS_Store
 /build/git_askpass.sh
 tests/smoke/mybuns/
+.env
+trivy-results.sarif
 
 .cnab
 examples/**/Dockerfile

CONTRIBUTING.md

@@ -14,10 +14,12 @@
   * [Makefile explained](#makefile-explained)
   * [Install mixins](#install-mixins)
   * [Preview documentation](#preview-documentation)
+  * [View a trace of a Porter command](#view-a-trace-of-a-porter-command)
   * [Write a blog post](#write-a-blog-post)
 * [Code structure and practices](#code-structure-and-practices)
   * [What is the general code layout?](#what-is-the-general-code-layout)
   * [Logging](#logging)
+  * [Breaking Changes](#breaking-changes)
 * [Infrastructure](#infrastructure)
   * [CDN Setup](#cdn-setup)
   * [Releases](#releases)
@@ -113,13 +115,13 @@ example output
 We recommend running the following every time:
 
 ```
-make verify build test-unit
+mage Build TestUnit
 ```
 
 If your test modified anything related to running a bundle, also run:
 
 ```
-make test-integration
+mage TestIntegration
 ```
 
 If you want to know _all_ the targets that the CI runs, look at
@@ -248,13 +250,14 @@ maintainer.
 
 ## Initial setup
 
-We have a [tutorial] that walks you through how to setup your developer
+We have a [tutorial] that walks you through how to set up your developer
 environment, make a change and test it.
 
 Here are the key steps, if you run into trouble, the tutorial has more details:
 
+1. Install Go version 1.17 or higher.
 1. Clone this repository with `git clone https://github.com/getporter/porter.git ~/go/src/get.porter.sh/porter`.
-1. Run `make build install` from within the newly cloned repository.
+1. Run `mage Build Install` from within the newly cloned repository.
 
 If you are planning on contributing back to the project, you'll need to
 [fork](https://guides.github.com/activities/forking/) and clone your fork. If
@@ -276,53 +279,45 @@ Mage targets are not case-sensitive, but in our docs we use camel case to make
 it easier to read. You can run either `mage TestSmoke` or `mage testsmoke` for
 example.
 
+* **Build** builds all binaries, porter and internal mixins.
+  * **BuildClient** just builds the porter client for your operating system.
+    It does not build the porter-runtime binary. Useful when you just want to do a
+    build and don't remember the proper way to call `go build` yourself.
+  * **BuildPorter**     builds both the porter client and runtime.
 * **Clean** removes artifacts from previous builds and test runs.
-* **TestSmoke** runs a small suite of tests using the Porter CLI to validate
-  that Porter is (mostly) working.
-* **TestIntegration** runs our integration tests, which run the bundles
-  against a test KIND cluster.
 * **UpdateTestfiles** updates the "golden" test files to match the latest test output.
   This is mostly useful for when you change the schema of porter.yaml which will
   break TestPorter_PrintManifestSchema. Run this target to fix it.
   Learn more about [golden files].
-
+* **Test** runs all the tests.
+  * **TestUnit** runs the unit tests
+  * **TestSmoke** runs a small suite of tests using the Porter CLI to validate
+    that Porter is (mostly) working.
+  * **TestIntegration** runs our integration tests, which run the bundles
+    against a test KIND cluster.
+* **Install** installs porter _and_ the mixins from source into **$(HOME)/.porter/**.
+* **DocsPreview** hosts the docs site. See [Preview Documentation](#preview-documentation).
+* **DocsGen** generates the CLI documentation for the website. This is run automatically by build.
+
 [golden files]: https://ieftimov.com/post/testing-in-go-golden-files/
 
 ### Make Targets
 
 Below are the most common developer tasks. Run a target with `make TARGET`, e.g.
-`make build`.
-
-* `build` builds all binaries, porter and internal mixins.
-* `build-porter-client` just builds the porter client for your operating system.
-  It does not build the porter-runtime binary. Useful when you just want to do a
-  build and don't remember the proper way to call `go build` yourself.
-* `build-porter` builds both the porter client and runtime. It does not clean up
-  generated files created by packr, so you usually want to also run
-  `clean-packr`.
-* `install-porter` installs porter from source into your home directory **$(HOME)/.porter**.
-* `install-mixins` installs the mixins from source into **$(HOME)/.porter/**.
-  This is useful when you are working on the exec or kubernetes mixin.
-* `install` installs porter _and_ the mixins from source into **$(HOME)/.porter/**.
-* `test-unit` runs the unit tests.
-* `docs-preview` hosts the docs site. See [Preview
-  Documentation](#preview-documentation).
-* `test` runs all the tests.
-* `clean-packr` removes extra packr files that were a side-effect of the build.
-  Normally this is run automatically but if you run into issues with packr, 
-  run this command.
+`make setup-dco`.
+
 * `setup-dco` installs a git commit hook that automatically signsoff your commit
   messages per the DCO requirement.
 
 ## Test Porter
 
 We have a few different kinds of tests in Porter. You can run all tests types
-with `make test`.
+with `mage test`.
 
 ### Unit Tests
 
 ```
-make test-unit
+mage TestUnit
 ```
 
 Should not rely on Docker, or try to really run bundles without key components
@@ -334,7 +329,7 @@ Fast! 🏎💨 This takes about 15s - 3 minutes, depending on your computer hard
 ### Integration Tests
 
 ```
-make test-integration
+mage TestIntegration
 ```
 
 These tests run parts of Porter, using the Porter structs instead of the cli.
@@ -351,7 +346,7 @@ when you push commits to your pull request instead.
 When I am troubleshooting an integration test, I will run just the single test
 locally by using `go test -run TESTNAME ./...`. If the test needs infrastructure, 
 we have scripts that you can use, like `mage StartDockerRegistry` or 
-`make -f Makefile.kind install-kind create-kind-cluster`.
+`mage EnsureTestCluster`.
 
 Slow! 🐢 This takes between 8-16 minutes, depending on your computer hardware.
 
@@ -368,7 +363,7 @@ Short! We want this to always be something you can run in under 3 minutes.
 
 ## Install mixins
 
-When you run `make build`, the canary\* build of mixins are automatically
+When you run `mage build`, the canary\* build of mixins are automatically
 installed into your bin directory in the root of the repository. You can use
 `porter mixin install NAME` to install the latest released version of a mixin.
 
@@ -402,7 +397,7 @@ We use [Hugo](https://gohugo.io) to build our documentation site, and it is host
 [Netlify](https://netlify.com). You don't have to install Hugo locally because the
 preview happens inside a docker container.
 
-1. Run `make docs-preview` to start serving the docs. It will watch the file
+1. Run `mage DocsPreview` to start serving the docs. It will watch the file
 system for changes.
 1. Our make rule should open <http://localhost:1313/docs> to preview the
 site/docs.
@@ -447,12 +442,75 @@ a new blog post and then preview it:
 Our pull request preview and the live site will not show posts with a date in
 the future. If you don't see your post, change the date to today's date.
 
+## View a trace of a Porter command
+
+Porter can send trace data about the commands run to an OpenTelemetry backend.
+It can be very helpful when figuring out why a command failed because you can see the values of variables and stack traces.
+
+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 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.
+This tells Porter to turn on tracing, and connect to OpenTelemetry server that you just installed.
+
+**Posix**
+```bash
+export PORTER_TELEMETRY_ENABLED="true"
+export OTEL_EXPORTER_OTLP_PROTOCOL="grpc"
+export OTEL_EXPORTER_OTLP_INSECURE="true"
+```
+
+**Powershell**
+```powershell
+$env:PORTER_TELEMETRY_ENABLED="true"
+$env:OTEL_EXPORTER_OTLP_PROTOCOL="grpc"
+$env:OTEL_EXPORTER_OTLP_INSECURE="true"
+```
+
+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".
+
+The smoke and integration tests will run with telemetry enabled when the PORTER_TEST_TELEMETRY_ENABLED environment variable is true.
+
+[otel-jaeger bundle]: https://getporter.org/examples/src/otel-jaeger
+
 ## Command Documentation
 
 Our commands are documented at <https://porter.sh/cli> and that documentation is
 generated by our CLI. You should regenerate that documentation when you change
-any files in **cmd/porter** by running `make docs-gen` which is run every time
-you run `make build`.
+any files in **cmd/porter** by running `mage DocsGen` which is run every time
+you run `mage build`.
+
+## Work on the Porter Operator
+
+Instructions for building the Porter Operator from source are located in its repository: https://github.com/getporter/operator.
+Sometimes you may need to make changes to Porter and work on the Operator at the same time.
+Here's how to build porter so that you can use it locally:
+
+1. You must be on a feature branch. Not release/v1 or main. This matters because it affects the generated
+   docker image tag.
+1. Deploy the operator to a KinD cluster by running `mage deploy` from inside the operator repository.
+   That cluster has a local registry running that you can publish to, and it will pull images from it, 
+   running on localhost:5000.
+1. Run the following command from the porter repository to build the Porter Agent image, and publish it
+   to the test cluster's registry. `mage XBuildAll LocalPorterAgentBuild`.
+1. Edit your AgentConfig in the Porter Operator and set it to use your local build of the porter-agent.
+
+```yaml
+apiVersion: porter.sh/v1
+kind: AgentConfig
+metadata:
+  name: porter
+  namespace: test # You may need to change this depending on what you are testing
+spec:
+  porterRepository: localhost:5000/porter-agent
+  porterVersion: canary-dev
+  serviceAccount: porter-agent
+```
 
 # Code structure and practices
 
@@ -487,7 +545,9 @@ dependency injection and testing strategies.
     * **provider**: handles communicating with mixins
   * **porter**: the implementation of the porter commands. Every command in Porter
     has a corresponding function in here.
-    * **version**: reusable library used by all the mixins for implementing their
+    * **version**: reusable library used by all the mixins for implementing a mixin
+  * **secrets**: used to access porter's secret store through plugins.
+  * **storage**: used to access porter's data store through plugins.
   * **templates**: files that need to be compiled into the porter binary with
       version command.
 * **scripts**:
@@ -521,6 +581,20 @@ we send regular command output to `Out` and debug information to `Err`. It
 allows us to then run the command and see the debug output separately, like so
 `porter schema --debug 2> err.log`.
 
+## Breaking Changes
+
+Some changes in Porter break our compatibility with previous versions of Porter.
+When that happens, we need to release that change with a new major version number to indicate to users that it contains breaking changes.
+When you realize that you may need to make a breaking change, discuss it with a maintainer on the issue or pull request and we'll come up with a plan for how it should be released.
+Here are some examples of breaking changes:
+
+* The schema of porter.yaml changed.
+* The schema of Porter's [file formats](https://release-v1.porter.sh/reference/file-formats) changed.
+* The schema of Porter's [config file](https://release-v1.porter.sh/configuration/#config-file) changed.
+* Flags or behavior of a CLI command changed, such as removing a flag or adding a validation that can result in a hard error, preventing the command from running.
+
+All of Porter's documents have a schemaVersion field and when the schema of the document is changed, the version number should be incremented as well in the default set on new documents, the supported schema version constant in the code, and in the documentation for that document.
+
 # Infrastructure
 
 This section includes overviews of infrastructure Porter relies on, mostly intended

CONTRIBUTORS.md

@@ -57,6 +57,13 @@ and we will add you. **All** contributors belong here. 💯
 * [Om More](https://github.com/thisisommore)
 * [Avinash Upadhyaya](https://github.com/avinashupadhya99)
 * [Mike Barkas](https://github.com/mikebarkas)
+* [Joshua Bezaleel Abednego](https://github.com/joshuabezaleel)
+* [Avinash Upadhyaya](https://github.com/avinashupadhya99)
+* [Mahendra Bishnoi](https://github.com/mahendrabishnoi2)
+* [Yingrong Zhao](https://github.com/VinozzZ)
+* [Saksham Sharma](https://github.com/sakkshm26)
+* [Jeremy Goss](https://github.com/Jemgoss)
+* [Chioma Onyekpere](https://github.com/Simpcyclassy)
 * [Saksham Sharma](https://github.com/sakkshm26)
 * [Quentin Petraroia](https://github.com/qpetraroia)
 * [Tamir Kamara](https://github.com/tamirkamara)