Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions content/en/docs/apis/porch/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: "Package Orchestration API Specifications"
type: docs
weight: 5
description: Reference for the Nephio Porch APIs
description: Reference for the Porch APIs
---
{{< iframe src="https://doc.crds.dev/github.com/nephio-project/porch@v1.4.0" sub="https://doc.crds.dev/github.com/nephio-project/porch@v1.4.0">}}
For detailed API and CRD specifications, please refer to:

- [Porch Aggregated API type definitions](https://docs.porch.nephio.org/docs/7_cli_api/api-ref/)

Check failure on line 9 in content/en/docs/apis/porch/_index.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/7_cli_api/api-ref/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/7_cli_api/api-ref/ Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/7_cli_api/api-ref/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/7_cli_api/api-ref/" location:{path:"content/en/docs/apis/porch/_index.md" range:{start:{line:9 column:3} end:{line:9 column:97}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
- [Porch CRD Reference](https://docs.porch.nephio.org/docs/7_cli_api/crd-ref/)

Check failure on line 10 in content/en/docs/apis/porch/_index.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/7_cli_api/crd-ref/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/7_cli_api/crd-ref/ Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/7_cli_api/crd-ref/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/7_cli_api/crd-ref/" location:{path:"content/en/docs/apis/porch/_index.md" range:{start:{line:10 column:3} end:{line:10 column:79}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
2 changes: 1 addition & 1 deletion content/en/docs/glossary-abbreviations.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ services, applications, etc.) which:
* abstracts configuration file structure and storage from operations that act upon the configuration data; clients
manipulating configuration data don’t need to directly interact with storage (git, container images)

Source of definition and more information about Configuration as Data can be found in the [kpt documentation](/content/en/docs/porch/config-as-data.md).
Source of definition and more information about Configuration as Data can be found in the [kpt documentation](https://kpt.dev/book/02-concepts/#configuration-as-data-key-principles).

## Controller
This term comes from Kubernetes where
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/install-guides/install-on-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- *kubectl* [installed ](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)on your workstation
- *kpt* [installed](https://kpt.dev/installation/kpt-cli) on your workstation
(version v1.0.0-beta.43 or later)
- *porchctl* [installed](/content/en/docs/porch/user-guides/porchctl-cli-guide.md) on your workstation
- *porchctl* [installed](https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/) on your workstation

Check failure on line 24 in content/en/docs/guides/install-guides/install-on-byoc.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/" location:{path:"content/en/docs/guides/install-guides/install-on-byoc.md" range:{start:{line:24 column:15} end:{line:24 column:101}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
- Sudo-less *docker*, *Podman*, or *nerdctl*. If using *Podman* or *nerdctl*,
you must set the
[`KPT_FN_RUNTIME`](https://kpt.dev/reference/cli/fn/render/?id=environment-variables)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* Kubernetes version 1.26+
* *kubectl* [installed ](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/)
* *kpt* [installed](https://kpt.dev/installation/kpt-cli) (version v1.0.0-beta.43 or later)
* *porchctl* [installed](/content/en/docs/porch/user-guides/porchctl-cli-guide.md) on your workstation
* *porchctl* [installed](https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/) on your workstation

Check failure on line 22 in content/en/docs/guides/install-guides/install-on-multiple-vm.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/3_getting_started/installing-porchctl/" location:{path:"content/en/docs/guides/install-guides/install-on-multiple-vm.md" range:{start:{line:22 column:14} end:{line:22 column:100}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

## Installation of the management cluster

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@

Once *Ready*, we can utilize blueprint packages from these upstream repositories.

In this example, we will use the [Porch package variant controller](/content/en/docs/porch/package-variant.md#core-concepts)
In this example, we will use the [Porch package variant controller](https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts)

Check failure on line 67 in content/en/docs/guides/user-guides/usecase-user-guides/exercise-3-fluxcd-wl.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts" location:{path:"content/en/docs/guides/user-guides/usecase-user-guides/exercise-3-fluxcd-wl.md" range:{start:{line:67 column:34} end:{line:67 column:183}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
to deploy the new Workload Cluster.

This fully automates the onboarding process, including the auto approval and publishing of the new package.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@

Once *Ready*, we can utilize blueprint packages from these upstream repositories.

In this example, we will use the [Porch package variant controller](/content/en/docs/porch/package-variant.md#core-concepts)
In this example, we will use the [Porch package variant controller](https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts)

Check failure on line 164 in content/en/docs/guides/user-guides/usecase-user-guides/exercise-5-argocd-wl.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Raw Output: message:"Cannot reach https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/docs/5_architecture_and_components/relevant_old_docs/package-variant/#core-concepts" location:{path:"content/en/docs/guides/user-guides/usecase-user-guides/exercise-5-argocd-wl.md" range:{start:{line:164 column:34} end:{line:164 column:183}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}
to deploy the new Workload Cluster.

This fully automates the onboarding process, including the auto approval and publishing of the new package.
Expand Down
12 changes: 8 additions & 4 deletions content/en/docs/porch/_index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
title: "Porch documentation"
title: "Porch"
type: docs
weight: 6
description: Documentation of Porch
---

## Overview

{{% alert title="Note" color="primary" %}}

**The Porch documentation has been moved to [https://docs.porch.nephio.org/](https://docs.porch.nephio.org/).**

Check failure on line 10 in content/en/docs/porch/_index.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach https://docs.porch.nephio.org/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/ Raw Output: message:"Cannot reach https://docs.porch.nephio.org/ Status: null net::ERR_NAME_NOT_RESOLVED at https://docs.porch.nephio.org/" location:{path:"content/en/docs/porch/_index.md" range:{start:{line:10 column:45} end:{line:10 column:109}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

{{% /alert %}}

Porch is “kpt-as-a-service”, providing opinionated package management, manipulation, and lifecycle operations in a
Kubernetes-based API. This allows automation of these operations using standard Kubernetes controller techniques.

Expand All @@ -20,4 +24,4 @@

Porch is maintained by the Nephio community. Porch will evolve with Nephio and
its architecture and implementation will be updated to meet the functional and non-functional requirements on it
and on Nephio as a whole.
and on Nephio as a whole.
156 changes: 0 additions & 156 deletions content/en/docs/porch/config-as-data.md

This file was deleted.

116 changes: 0 additions & 116 deletions content/en/docs/porch/contributors-guide/_index.md

This file was deleted.

Loading
Loading