Skip to content

Commit

Permalink
Fix some more
Browse files Browse the repository at this point in the history
Signed-off-by: Kim Christensen <kimworking@gmail.com>
  • Loading branch information
kichristensen committed May 24, 2024
1 parent c90dbbe commit bd42689
Show file tree
Hide file tree
Showing 54 changed files with 406 additions and 128 deletions.
15 changes: 13 additions & 2 deletions docs/.htmltest.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
IgnoreURLs:
- ^/forum$
- ^/zoom/dev/$
- ^/dev-meeting$
- ^/dev-meeting
- ^/calendar/$
- ^/find-issue/$
- ^/find-issue
- ^/board/
- ^/roadmap
- ^/src
- ^/examples
- ^/forum
- ^/packages
- ^/schema/
- ^/docker-mixin/src
- ^/mailing-list/$
- ^/videos/?$
- ^/devstats/$
- ^/twitter/$
- ^/slack/?$
- ^/v\d\.
- ^/latest/
- ^/community/src/
- http://localhost:1313/docs
IgnoreAltMissing: true
IgnoreInternalEmptyHash: true
2 changes: 1 addition & 1 deletion docs/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Porter is an open-source project that packages your application, client tools, c
- [Porter Overview](/architecture/)
- [Install Porter](/install/)
- [Quick Start](/quickstart/)
- [Frequently Asked Questions](/faq)
- [Frequently Asked Questions](/faq/)
8 changes: 4 additions & 4 deletions docs/content/docs/administration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ weight: 6
**Learn about managing Administration**

{{< cards >}}
{{< card link="inspecting-bundles" title="Inspecting Bundles" >}}
{{< card link="copy-bundles" title="Copy Bundles" >}}
{{< card link="move-bundles-airgapped" title="Move Bundles Across Airgapped Environments" >}}
{{< card link="collect-diag-porter" title="Collect Diagnostics from Porter" >}}
{{< card link="inspecting-bundles/" title="Inspecting Bundles" >}}
{{< card link="copy-bundles/" title="Copy Bundles" >}}
{{< card link="move-bundles-airgapped/" title="Move Bundles Across Airgapped Environments" >}}
{{< card link="collect-diag-porter/" title="Collect Diagnostics from Porter" >}}
{{< /cards >}}
4 changes: 2 additions & 2 deletions docs/content/docs/administration/collect-diag-porter.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ See [Telemetry Settings][telemetry] for all the supported configuration settings

[compat]: https://opentelemetry.io/vendors/
[OpenTelemetry environment variables]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/protocol/exporter.md
[telemetry]: /configuration/#telemetry
[Log Settings]: /configuration/#logs
[telemetry]: /docs/configuration/configuration/#telemetry
[Log Settings]: /docs/configuration/configuration/#logs
[OpenTelemetry]: https://opentelemetry.io
[otel-jaeger bundle]: /examples/src/otel-jaeger
2 changes: 1 addition & 1 deletion docs/content/docs/administration/inspecting-bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:
- /inspect-bundle/
---

You've found a bundle that you'd like to use, but you'd like to what images will be used after you install the bundle. You can use the `porter inspect` command to see this information. If you'd like to see additional information, like parameters, credentials, and outputs, see the [explain](/operations/examine-bundles/) command.
You've found a bundle that you'd like to use, but you'd like to what images will be used after you install the bundle. You can use the `porter inspect` command to see this information. If you'd like to see additional information, like parameters, credentials, and outputs, see the [explain](/docs/operations/examine-bundles/) command.

When a bundle is published, the images that it will use are copied into the location of the published bundle. This simplifies access control and management of artifacts in the repository. The `inspect` command will show the invocation images, as well as any referenced images, that will be used as a result of performing actions like install nad upgrade. For each image, you will see the image reference that will be used, along with the original image reference that the image was copied from.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/administration/move-bundles-airgapped.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ At a high level, this involves the following steps:
4. Install the bundle referencing the new location of the bundle inside the airgapped network.

<figure>
<img src="/administration/porter-airgap-publish.png" alt="a drawing showing two networks side by side, separated by an airgap. Network A has a docker registry with a copy of a bundle that includes the bundle.json, installer and the whalesayd image. An arrow labeled porter archive leads to a box with all those components in a single box labeled whalegap.tgz. Then another arrow labeled with a disc goes across the airgap, copying the same whalegap.tgz box wit its components into Network B. Then a final arrow labeled porter publish puts a copy of the bundle and its contents in Registry B, inside Network B."/>
<img src="/docs/administration/porter-airgap-publish.png" alt="a drawing showing two networks side by side, separated by an airgap. Network A has a docker registry with a copy of a bundle that includes the bundle.json, installer and the whalesayd image. An arrow labeled porter archive leads to a box with all those components in a single box labeled whalegap.tgz. Then another arrow labeled with a disc goes across the airgap, copying the same whalegap.tgz box wit its components into Network B. Then a final arrow labeled porter publish puts a copy of the bundle and its contents in Registry B, inside Network B."/>
<figcaption>Moving the whalegap bundle across an airgap</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/best-practices/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 11
**Follow Best Practices**

{{< cards >}}
{{< card link="credentials-or-parameters" title="When to use credentials vs parameters" >}}
{{< card link="exec-mixin" title="Best Practices for the mixin." >}}
{{< card link="ci-pipeline" title="Best practices for Porter in a CI pipeline" >}}
{{< card link="credentials-or-parameters/" title="When to use credentials vs parameters" >}}
{{< card link="exec-mixin/" title="Best Practices for the mixin." >}}
{{< card link="ci-pipeline/" title="Best practices for Porter in a CI pipeline" >}}
{{< /cards >}}
4 changes: 2 additions & 2 deletions docs/content/docs/best-practices/ci-pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You can also specify the version of the mixin by adding the version flag. For ex
run: porter mixins install az --version v0.4.2
```
Take a look at the [documentation](/mixins) to see all available mixins and how to know what command to run to install them. The documentation provides install commands for each mixin. The command `porter mixin search` lists all the mixins created by the community. Depending on if the URL is an atom feed or a github url you can install the mixin using
Take a look at the [documentation](/mixins/) to see all available mixins and how to know what command to run to install them. The documentation provides install commands for each mixin. The command `porter mixin search` lists all the mixins created by the community. Depending on if the URL is an atom feed or a github url you can install the mixin using

```yaml
porter mixins install NAME --feed-url ATOM_URL
Expand Down Expand Up @@ -111,7 +111,7 @@ If you are not the only one contributing to the repository and other contributor

### Use credential files

If you were using credentials in your bundle, you will need to set up a credential file in your repository to use with your workflow. For example, if you run `porter credentials create mybun.json`, a JSON file named mybun.json is created. The resulting [credential set template file](/reference/file-formats/#credential-set) (which does not contain any sensitive credentials) is located in the current directory. You can run `porter credentials apply mybun.json` to apply the changes. If the specified credential set already exists, the changes will override the existing credential set, otherwise the apply command will create a new credential set. Then, to install your bundle with the newly created credential set, you would run the following:
If you were using credentials in your bundle, you will need to set up a credential file in your repository to use with your workflow. For example, if you run `porter credentials create mybun.json`, a JSON file named mybun.json is created. The resulting [credential set template file](/docs/references/file-formats/credential-set/) (which does not contain any sensitive credentials) is located in the current directory. You can run `porter credentials apply mybun.json` to apply the changes. If the specified credential set already exists, the changes will override the existing credential set, otherwise the apply command will create a new credential set. Then, to install your bundle with the newly created credential set, you would run the following:

```yaml
porter install -c <name-of-the-credential-set>
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/bundle/manifest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ be copied into the final bundle so that you can access them at runtime. The path

## See Also

* [Manifest File Format](/docs/reference/file-formats/#manifest)
* [Manifest File Format](/docs/bundle/manifest/file-format/)
* [Using Mixins](/use-mixins/)
* [Bundle Dependencies](/docs/development/authoring-a-bundle/working-with-dependencies/)
* [Parameters, Credentials, Outputs, and Images in Porter](/wiring/)
4 changes: 2 additions & 2 deletions docs/content/docs/bundle/manifest/file-format/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Below are schema versions for the Porter manifest, and the corresponding Porter
Sometimes you may want to work with a different version of a resource than what is supported by Porter, especially when migrating from one version of Porter to another.
The [schema-check] configuration setting allows you to change how Porter behaves when the schemaVersion of a resource doesn't match Porter's supported version.

[schema-check]: /configuration/#schema-check
[schema-check]: /docs/configuration/configuration/#schema-check

## Example

Expand Down Expand Up @@ -233,7 +233,7 @@ status:

## Next Steps

* [Create a Bundle](/development/authoring-a-bundle/create-a-bundle/)
* [Create a Bundle](/docs/development/authoring-a-bundle/create-a-bundle/)

[semver v2]: https://semver.org/spec/v2.0.0.html
[manifest-schema]: https://raw.githubusercontent.com/getporter/porter/main/pkg/schema/manifest.schema.json
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ Use the trace and logs configuration sections below to configure how logs and te

#### Logs

Porter can be configured to [write a logfile for each command](/administration/collect-diag-porter/#logs).
Porter can be configured to [write a logfile for each command](/docs/administration/collect-diag-porter/#logs).

The following log settings are available:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/contribute/work-with-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,4 @@ maintainer to admin.
<p align="center">Sound like fun? 👍 Join us!</p>

[contribution ladder]: /src/CONTRIBUTION_LADDER.md
[Slack]: /docs/community/#slack
[Slack]: /community/#slack
6 changes: 3 additions & 3 deletions docs/content/docs/development/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 7
**Learn about using Porter for Development**

{{< cards >}}
{{< card link="authoring-a-bundle" title="Authoring a Bundle" >}}
{{< card link="dev-a-mixin" title="Developing a Mixin" >}}
{{< card link="dist-a-mixin" title="Distributing a Mixin" >}}
{{< card link="authoring-a-bundle/" title="Authoring a Bundle" >}}
{{< card link="dev-a-mixin/" title="Developing a Mixin" >}}
{{< card link="dist-a-mixin/" title="Distributing a Mixin" >}}
{{< /cards >}}
10 changes: 5 additions & 5 deletions docs/content/docs/development/authoring-a-bundle/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ weight: 1
**Learn about Authoring a Bundle**

{{< cards >}}
{{< card link="create-a-bundle" title="Create a Bundle" >}}
{{< card link="use-custom-dockerfile" title="Using a Custom Dockerfile" >}}
{{< card link="working-with-dependencies" title="Working with Dependencies" >}}
{{< card link="using-templates" title="Using Templates" >}}
{{< card link="distribute-bundles" title="Distributing a Bundle" >}}
{{< card link="create-a-bundle/" title="Create a Bundle" >}}
{{< card link="use-custom-dockerfile/" title="Using a Custom Dockerfile" >}}
{{< card link="working-with-dependencies/" title="Working with Dependencies" >}}
{{< card link="using-templates/" title="Using Templates" >}}
{{< card link="distribute-bundles/" title="Distributing a Bundle" >}}
{{< /cards >}}
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You must [install Porter], and optionally can use the [Porter Visual Studio Code

## Create a Bundle

Use the [porter create](/cli/porter_create) command to scaffold a new bundle in the current directory.
Use the [porter create](/cli/porter_create/) command to scaffold a new bundle in the current directory.
The directory containing the files for the bundle is called the **bundle directory**.
The generated bundle is very similar to the [hello example bundle] and prints out "Hello World" when installed.
It does not allocate any resources and is safe to run and uninstall when you are finished.
Expand Down Expand Up @@ -181,16 +181,16 @@ $ porter explain ghcr.io/getporter/porter-hello:v0.2.0

Now that you know how to create a bundle, here are some more detailed topics on how to customize and distribute it:

- [Control how your bundle's image is built with a custom Dockerfile](/bundle/custom-dockerfile/)
- [Control how your bundle's image is built with a custom Dockerfile](/docs/bundle/custom-dockerfile/)
- [Customize your Porter manifest, porter.yaml][manifest]
- [Porter Manifest File Format](/bundle/manifest/file-format/)
- [Best Practices for the exec Mixin](/best-practices/exec-mixin/)
- [Understand how bundles are distributed](/development/authoring-a-bundle/distribute-bundles/)
- [Best Practices for the exec Mixin](/docs/best-practices/exec-mixin/)
- [Understand how bundles are distributed](/docs/development/authoring-a-bundle/distribute-bundles/)

[install Porter]: /install/
[Porter Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=getporter.porter-vscode
[hello example bundle]: /examples/hello/
[manifest]: /bundle/manifest/
[manifest]: /docs/bundle/manifest/
[local-registry]: https://docs.docker.com/registry/deploying/#run-a-local-registry
[porter create]: /cli/porter_create/
[porter build]: /cli/porter_build/
Expand All @@ -202,8 +202,8 @@ Now that you know how to create a bundle, here are some more detailed topics on
[Mixins]: /mixins/
[create a custom mixin]: /mixin-dev-guide/
[terraform mixin]: /mixins/terraform/
[do not embed bash commands]: /best-practices/exec-mixin/
[do not embed bash commands]: /docs/best-practices/exec-mixin/
[ignore-errors]: /blog/ignoring-errors/
[compatible registries]: /compatible-registries/
[custom Dockerfile]: /bundle/custom-dockerfile/
[custom Dockerfile]: /docs/bundle/custom-dockerfile/
[Buildkit]: https://docs.docker.com/develop/develop-images/build_enhancements/
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Here we can see that the spring-music image was relocated inside the published b
`jeremyrickard/spring-music@sha256:8f113...` → `jeremyrickard/porter-do-bundle@sha256:8f113...`
[images]: /author-bundles/#images
[images]: /docs/bundle/manifest/#images
### Archived Bundle Artifacts
Expand All @@ -163,4 +163,4 @@ ignored:
- `jeremyrickard/porter-do-bundle/spring-music`
[digest]: https://github.com/opencontainers/image-spec/blob/master/descriptor.md#digests
[image-map]: /author-bundles/#images
[image-map]: /docs/bundle/manifest/#images
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ install:
namespace: "myNamespace"
```

[custom metadata]: /author-bundles/#custom
[custom metadata]: /docs/bundle/manifest/#custom

#### parameters

Expand Down Expand Up @@ -224,7 +224,7 @@ image digest for the specified tag and then update the bundle to reference the i
by digest instead of the provided tag. This helps to ensure deterministic and
repeatable bundle execution.

[referenced images]: /author-bundles/#images
[referenced images]: /docs/bundle/manifest/#images

### env

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,4 +194,4 @@ transitive dependencies, are ignored. See [Design: Dependency Graph Resolution](
for our backlog item tracking this feature. We do plan to support it!

[example]: /src/build/testdata/bundles/wordpress/porter.yaml
[parameter-set]: /parameters#parameter-sets
[parameter-set]: /docs/introduction/concepts-and-components/intro-parameters/#parameter-sets
2 changes: 1 addition & 1 deletion docs/content/docs/development/dist-a-mixin.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ See the [Search Guide][search-guide] on how to search for available mixins and/o
add your own to the list.

[mk]: /src/mixin.mk
[search-guide]: /package-search
[search-guide]: /package-search/
4 changes: 3 additions & 1 deletion docs/content/docs/faq/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: FAQ
description: Frequently Asked Questions
weight: 16
aliases:
- /faq/
---

- [What is CNAB?](#what-is-cnab)
Expand Down Expand Up @@ -96,7 +98,7 @@ standard mechanism defined by the CNAB spec yet.

When you create a new bundle, porter generates Dockerfile.tmpl file for you. In
the porter.yaml you can specify `dockerfile: dockerfile.tmpl` to tell Porter
that you want to use the template (see [Custom Dockerfile](/bundle/custom-dockerfile/)) and then you can customize
that you want to use the template (see [Custom Dockerfile](/docs/bundle/custom-dockerfile/)) and then you can customize
it however you need. You're on the right track, from there you can use the exec
mixin to call whatever you installed.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/how-to-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ aliases:
**Guides for working with Mixins and Plugins**

{{< cards >}}
{{< card link="work-with-mixins" title="Working with Mixins" >}}
{{< card link="work-with-plugins" title="Working with Plugins" >}}
{{< card link="work-with-mixins/" title="Working with Mixins" >}}
{{< card link="work-with-plugins/" title="Working with Plugins" >}}
{{< /cards >}}
2 changes: 1 addition & 1 deletion docs/content/docs/how-to-guides/work-with-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ $ porter credentials apply plugins-tutorial.json
Applied /plugins-tutorial credential set
```

For more information on how to use `porter credentials` commands, take a look at our [credentials quickstart guide](/quickstart/credentials).
For more information on how to use `porter credentials` commands, take a look at our [credentials quickstart guide](/quickstart/credentials/).

Now we are ready to install the bundle and pass it our generated credentials. 🎉
Porter is using the Azure plugin to inject the password credential from Azure
Expand Down
8 changes: 4 additions & 4 deletions docs/content/docs/integrations/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ weight: 12
**Learn about various Integrations with Porter**

{{< cards >}}
{{< card link="aks" title="Connect to AKS" >}}
{{< card link="gke" title="Connect to GKE" >}}
{{< card link="kind" title="Connect to KinD" >}}
{{< card link="minikube" title="Connect to Minikube" >}}
{{< card link="aks/" title="Connect to AKS" >}}
{{< card link="gke/" title="Connect to GKE" >}}
{{< card link="kind/" title="Connect to KinD" >}}
{{< card link="minikube/" title="Connect to Minikube" >}}
{{< /cards >}}
2 changes: 1 addition & 1 deletion docs/content/docs/integrations/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ See [ghcr.io/getporter/examples/gke][example] for a full working example bundle.
recommended over using a parameter. Using parameters to define environment
variables is a hack provided only for the purpose of this example.

- Add the following line to your [Custom Dockerfile](/bundle/custom-dockerfile):
- Add the following line to your [Custom Dockerfile](/docs/bundle/custom-dockerfile/):

```
ENV GOOGLE_APPLICATION_CREDENTIALS=/home/nonroot/google-service-account.json
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/integrations/kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

### Porter time!

Porter bundles that access a Kubernetes cluster when running can now be installed as normal, once the [Credential Set](/references/file-formats/credential-set/) is generated/edited to use the KinD kubeconfig.
Porter bundles that access a Kubernetes cluster when running can now be installed as normal, once the [Credential Set](/docs/references/file-formats/credential-set/) is generated/edited to use the KinD kubeconfig.

Here we'll create and edit credentials and then install the [MySQL bundle](/src/build/testdata/bundles/mysql):

Expand Down
4 changes: 2 additions & 2 deletions docs/content/docs/introduction/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ weight: 1
**Start learning about Porter today**

{{< cards >}}
{{< card link="what-is-porter" title="What is Porter?" >}}
{{< card link="concepts-and-components" title="Concepts and Components" >}}
{{< card link="what-is-porter/" title="What is Porter?" >}}
{{< card link="concepts-and-components/" title="Concepts and Components" >}}
{{< /cards >}}
18 changes: 9 additions & 9 deletions docs/content/docs/introduction/concepts-and-components/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: ""
**Learn about all the different Concepts and Components**

{{< cards >}}
{{< card link="intro-bundles" title="Bundles" >}}
{{< card link="intro-parameters" title="Parameters" >}}
{{< card link="intro-configuration" title="Configuration" >}}
{{< card link="intro-credentials" title="Credentials" >}}
{{< card link="intro-desired-state" title="Desired State" >}}
{{< card link="intro-invocation-images" title="Invocation Images" >}}
{{< card link="intro-mixins" title="Mixins" >}}
{{< card link="mixins-vs-plugins" title="Mixins vs Plugins" >}}
{{< card link="intro-plugins" title="Plugins" >}}
{{< card link="intro-bundles/" title="Bundles" >}}
{{< card link="intro-parameters/" title="Parameters" >}}
{{< card link="intro-configuration/" title="Configuration" >}}
{{< card link="intro-credentials/" title="Credentials" >}}
{{< card link="intro-desired-state/" title="Desired State" >}}
{{< card link="intro-invocation-images/" title="Invocation Images" >}}
{{< card link="intro-mixins/" title="Mixins" >}}
{{< card link="mixins-vs-plugins/" title="Mixins vs Plugins" >}}
{{< card link="intro-plugins/" title="Plugins" >}}
{{< /cards >}}
Loading

0 comments on commit bd42689

Please sign in to comment.