Skip to content
Open
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
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 @@
* 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](/docs/porch/config-as-data.md).

Check failure on line 48 in content/en/docs/glossary-abbreviations.md

View workflow job for this annotation

GitHub Actions / docs

[Linkspector] reported by reviewdog 🐶 Cannot reach /docs/porch/config-as-data.md Status: 404 Cannot find: /docs/porch/config-as-data.md Raw Output: message:"Cannot reach /docs/porch/config-as-data.md Status: 404 Cannot find: /docs/porch/config-as-data.md" location:{path:"content/en/docs/glossary-abbreviations.md" range:{start:{line:48 column:91} end:{line:48 column:141}}} severity:ERROR source:{name:"linkspector" url:"https://github.com/UmbrellaDocs/linkspector"}

## Controller
This term comes from Kubernetes where
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/guides/install-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,12 +198,12 @@ ssh <user>@<vm-address>
## Next steps

* Go through the following exercises:
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig in to the [user guide](/content/en/docs/guides/user-guides/_index.md).
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig in to the [user guide](/docs/guides/user-guides/_index.md).
* Nephio sandbox environment:
* Install on preprovisioned single VM.
* Install on a GCE.
* [Explore sandbox environment](/content/en/docs/guides/install-guides/explore-sandbox.md)
* [Bring-Your-Own-Cluster](/content/en/docs/guides/install-guides/install-on-byoc.md)
* [Install using vagrant on Windows (for development)](/content/en/docs/guides/install-guides/demo-vagrant-windows.md)
* [Explore sandbox environment](/docs/guides/install-guides/explore-sandbox.md)
* [Bring-Your-Own-Cluster](/docs/guides/install-guides/install-on-byoc.md)
* [Install using vagrant on Windows (for development)](/docs/guides/install-guides/demo-vagrant-windows.md)
2 changes: 1 addition & 1 deletion content/en/docs/guides/install-guides/explore-sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 5
---


You have installed the Nephio single VM [using the installation instructions](/content/en/docs/guides/install-guides/install-on-single-vm.md).
You have installed the Nephio single VM [using the installation instructions](/docs/guides/install-guides/install-on-single-vm.md).
The installation has done a good job of installing a complex software stack without any fuss. Let's take a look around.

![Software Installed by the Nephio Sandbox Installation](/static/images/install-guides/ManagementCluster.png)
Expand Down
16 changes: 8 additions & 8 deletions 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 @@ your environment and choices.
- *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](/docs/porch/user-guides/porchctl-cli-guide.md) on your workstation
- 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 Expand Up @@ -59,10 +59,10 @@ descriptions of the various options, if you wish to assemble your own set of com

| Environment | Description |
| ----------- | ---------------------------------------------------------- |
| [Single VM](/content/en/docs/guides/install-guides/install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. |
| [Multiple VM](/content/en/docs/guides/install-guides/install-on-multiple-vm.md) | The multiple VM environment, set up Nephio on multiple VMs. These instructions cover both Ubuntu and Fedora. |
| [Google Cloud Platform](/content/en/docs/guides/install-guides/install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and WebUI authentication and authorization via Google OAuth 2.0 |
| [OpenShift](/content/en/docs/guides/install-guides/install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and WebUI authentication backed by OpenShift OIDC. |
| [Single VM](/docs/guides/install-guides/install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. |
| [Multiple VM](/docs/guides/install-guides/install-on-multiple-vm.md) | The multiple VM environment, set up Nephio on multiple VMs. These instructions cover both Ubuntu and Fedora. |
| [Google Cloud Platform](/docs/guides/install-guides/install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and WebUI authentication and authorization via Google OAuth 2.0 |
| [OpenShift](/docs/guides/install-guides/install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and WebUI authentication backed by OpenShift OIDC. |

## À La Carte Installation

Expand Down Expand Up @@ -95,7 +95,7 @@ environment, so that installation will be documented in the specific environment
### GitOps Tool

As configured in the R1, R2 and R3 reference implementation, Nephio relies on ConfigSync. However, it is possible to
configure it to use a different GitOps tool, such as [FluxCD](/content/en/docs/guides/install-guides/optional-components.md#fluxcd-controllers)
configure it to use a different GitOps tool, such as [FluxCD](/docs/guides/install-guides/optional-components.md#fluxcd-controllers)
or ArgoCD to apply packages to the clusters.

### Cluster Provisioner
Expand Down Expand Up @@ -133,8 +133,8 @@ LoadBalancer service, Ingress, or Route).

The WebUI currently supports the following options:

- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md)
- [Google OAuth or OIDC](/docs/guides/install-guides/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/docs/guides/install-guides/web-ui/webui-auth-okta.md)

### Nephio Stock Repositories

Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/guides/install-guides/install-on-gce.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ gcloud compute ssh ubuntu@nephio-main-e2e
## Next Steps

* Step through the exercises
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md)
* [Free5GC Testbed Deployment and E2E testing with UERANSIM](/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md)
* [OAI Core and RAN Testbed Deployment and E2E testing](/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md)
* Dig into the [user guide](/docs/guides/user-guides/_index.md)
* In case you want to install Nephio on pre-provisioned VMs:
* [Single VM](/content/en/docs/guides/install-guides/install-on-single-vm.md)
* [Multiple VM](/content/en/docs/guides/install-guides/install-on-multiple-vm.md)
* [Single VM](/docs/guides/install-guides/install-on-single-vm.md)
* [Multiple VM](/docs/guides/install-guides/install-on-multiple-vm.md)

12 changes: 6 additions & 6 deletions content/en/docs/guides/install-guides/install-on-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -1024,9 +1024,9 @@ git commit -m "Initial checking of nephio-mgmt"
**Prior to deploying the package, we need to manually setup the secret for the
WebUI.**

See [Google OAuth 2.0 or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md) for details on how to
set up OAuth. In particular you need to [create the client ID](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md#creating-an-oauth-20-client-id)
and the [secret](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md#create-the-secret-in-the-cluster)
See [Google OAuth 2.0 or OIDC](/docs/guides/install-guides/web-ui/webui-auth-gcp.md) for details on how to
set up OAuth. In particular you need to [create the client ID](/docs/guides/install-guides/web-ui/webui-auth-gcp.md#creating-an-oauth-20-client-id)
and the [secret](/docs/guides/install-guides/web-ui/webui-auth-gcp.md#create-the-secret-in-the-cluster)
manually.

The *nephio-webui* subpackage in *nephio-mgmt* is already set up for
Expand Down Expand Up @@ -1389,6 +1389,6 @@ use workloads that do not rely on that functionality in order to experiment with

{{% /alert %}}

* Step through the [Free5GC](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md) and
[OAI](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md) exercises
* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md)
* Step through the [Free5GC](/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md) and
[OAI](/docs/guides/user-guides/usecase-user-guides/exercise-2-oai.md) exercises
* Dig into the [user guide](/docs/guides/user-guides/_index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ weight: 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](/docs/porch/user-guides/porchctl-cli-guide.md) on your workstation

## Installation of the management cluster

### Manual Installation of the management cluster using kpt

- [Common Dependencies](/content/en/docs/guides/install-guides/common-dependencies.md)
- [Common Components](/content/en/docs/guides/install-guides/common-components.md)
- [Common Dependencies](/docs/guides/install-guides/common-dependencies.md)
- [Common Components](/docs/guides/install-guides/common-components.md)

## Manual Installation of the Edge cluster using kpt

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/guides/install-guides/install-on-openshift.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ If using init.sh directly to deploy Nephio management components, as one would f
- A default StorageClass must be configured providing persistent storage for PVCs (for instance through the LVMS Operator and an LVMCluster)
- [Security Context Constraints](https://github.com/nephio-project/catalog/tree/main/distros/openshift/security-context-constraints) must be applied for successful Nephio component deployment

Follow the steps present in the [Install Guide](/content/en/docs/guides/install-guides/_index.md) for a Pre-installed K8s Cluster to install management components
Follow the steps present in the [Install Guide](/docs/guides/install-guides/_index.md) for a Pre-installed K8s Cluster to install management components


### Option 2: Using Blueprints Nephio OpenShift Repository OpenShift Package Repository
Expand All @@ -79,8 +79,8 @@ Application:
oc apply -f https://raw.githubusercontent.com/openshift-telco/blueprints-nephio-openshift/v1.0.1/nephio-mgnt/app-of-apps.yaml
```

This will take care of applying the [common dependencies](/content/en/docs/guides/install-guides/common-dependencies.md)
and the [common components](/content/en/docs/guides/install-guides/common-components.md)
This will take care of applying the [common dependencies](/docs/guides/install-guides/common-dependencies.md)
and the [common components](/docs/guides/install-guides/common-components.md)

### Access the Nephio WebUI

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/install-on-single-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,12 @@ kpt live apply gitea --reconcile-timeout 15m --output=table

There are a few dependencies that are common across most installations, and do not require any installation-specific
setup. You should install these next, as described in the
[common dependencies documentation](/content/en/docs/guides/install-guides/common-dependencies.md).
[common dependencies documentation](/docs/guides/install-guides/common-dependencies.md).

## Common Components

With the necessary dependencies now installed, you can now install the essential Nephio components. This is documented
in the [common components documentation](/content/en/docs/guides/install-guides/common-components.md).
in the [common components documentation](/docs/guides/install-guides/common-components.md).

## Provisioning Cluster API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ kpt pkg get --for-deployment <git-repository>@v4.0.0
## Nephio WebUI

The Nephio WebUI can be installed using the following
[document](/content/en/docs/guides/install-guides/web-ui/_index.md)
[document](/docs/guides/install-guides/web-ui/_index.md)


## FluxCD Controllers
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/web-ui/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ service).
Configuring authentication for the WebUI is specific to the particular cluster environment. Guides for different
environments are below:

- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md)
- [Google OAuth or OIDC](/docs/guides/install-guides/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/docs/guides/install-guides/web-ui/webui-auth-okta.md)

Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`,
since in the previous steps we may have created the namespace already).
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/guides/user-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,10 @@ The diagram below depicts deployment at the high level.
## Troubleshooting and Workarounds

On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the
Release Notes [known issues](/content/en/docs/release-notes/R2.md#known-issues-and-workarounds).
Release Notes [known issues](/docs/release-notes/R2.md#known-issues-and-workarounds).

## Next Steps

* Learn more about the Nephio [controllers](/content/en/docs/guides/user-guides/operator-controller-guides/controllers.md)
* Learn more about how packages are [transformed](/content/en/docs/guides/install-guides/package-transformations.md)
* Learn more about [deploying helm charts](/content/en/docs/guides/user-guides/helm/_index.md) in Nephio
* Learn more about the Nephio [controllers](/docs/guides/user-guides/operator-controller-guides/controllers.md)
* Learn more about how packages are [transformed](/docs/guides/install-guides/package-transformations.md)
* Learn more about [deploying helm charts](/docs/guides/user-guides/helm/_index.md) in Nephio
4 changes: 2 additions & 2 deletions content/en/docs/guides/user-guides/helm/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ for deploying on Kubernetes, legacy helm support will be required for a number o

### Deployment options

* [Using Helm To Operator Codegen SDK](/content/en/docs/guides/user-guides/helm/helm-to-operator-codegen-sdk-user-guide.md)
* [Using Flux CD](/content/en/docs/guides/user-guides/helm/flux-helm.md)
* [Using Helm To Operator Codegen SDK](/docs/guides/user-guides/helm/helm-to-operator-codegen-sdk-user-guide.md)
* [Using Flux CD](/docs/guides/user-guides/helm/flux-helm.md)
* [Operator SDK](https://sdk.operatorframework.io/docs/building-operators/helm/)

8 changes: 4 additions & 4 deletions content/en/docs/guides/user-guides/helm/flux-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa

## Prerequisites:

* [Nephio R1 sandbox]/content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment.
* [Access to the Nephio Web UI](/content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces)
* [Nephio R1 sandbox workload clusters](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md):
* [Nephio R1 sandbox]/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment.
* [Access to the Nephio Web UI](/docs/guides/install-guides/_index.md#access-to-the-user-interfaces)
* [Nephio R1 sandbox workload clusters](/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md):
Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including
[Step 3](/content/en/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters).
[Step 3](/docs/guides/user-guides/usecase-user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters).

### Deploying the flux-helm-controllers pkg

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -342,4 +342,4 @@ release-name-free5gc-webui-webui-7dccf6c877-lj5p5 1/1 Running
```

----
For advanced requirements, Please refer to the developer guide [here](/content/en/docs/guides/contributor-guides/helm-to-operator-codegen-sdk-developer-guide.md)
For advanced requirements, Please refer to the developer guide [here](/docs/guides/contributor-guides/helm-to-operator-codegen-sdk-developer-guide.md)
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 2

## Introduction

Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md)
Be sure you have followed the [installation guide](/docs/guides/install-guides/_index.md)
before trying these exercises.

These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with:
Expand Down Expand Up @@ -1011,7 +1011,7 @@ Additionally you can check the Gitea edge01 repository (accessible at http://loc
![Commits in Gitea made by porch](/static/images/user-guides/gitea-porch.png)

After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data
([port forwarding](/content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) must be running).
([port forwarding](/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) must be running).

![Deployments in Nephio UI](/static/images/user-guides/UPF-Capacity.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: >
weight: 2
---

Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md) before trying these exercises.
Be sure you have followed the [installation guide](/docs/guides/install-guides/_index.md) before trying these exercises.

These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ weight: 2

## Prerequisites

- A Nephio Management cluster. See the [installation guides](/content/en/docs/guides/install-guides/_index.md)
- A Nephio Management cluster. See the [installation guides](/docs/guides/install-guides/_index.md)
for detailed environment options.
- The following *optional* pkg deployed:
- [FluxCD controllers](/content/en/docs/guides/install-guides/optional-components.md#fluxcd-controllers)
- [FluxCD controllers](/docs/guides/install-guides/optional-components.md#fluxcd-controllers)

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

If using a [sandbox demo environment](/content/en/docs/guides/install-guides/_index.md#kicking-off-an-installation-on-a-virtual-machine),
If using a [sandbox demo environment](/docs/guides/install-guides/_index.md#kicking-off-an-installation-on-a-virtual-machine),
most of the above prerequisites are already satisfied.

{{% /alert %}}
Expand Down Expand Up @@ -64,7 +64,7 @@ oai-core-packages git Package false True https://github

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](/docs/porch/package-variant.md#core-concepts)
to deploy the new Workload Cluster.

This fully automates the onboarding process, including the auto approval and publishing of the new package.
Expand Down
Loading
Loading