Skip to content

Commit

Permalink
Fix image links in markdown files (#103)
Browse files Browse the repository at this point in the history
This PR fixes the image links in the markdown files in the Nephio
documentation. Prior to this PR, the images did not appear whent he
markdown was rendered.
  • Loading branch information
liamfallon committed Feb 2, 2024
1 parent 994ff89 commit fa5ceee
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 41 deletions.

This file was deleted.

Binary file not shown.

This file was deleted.

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 @@ -9,7 +9,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).
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](/images/install-guides/ManagementCluster.png)
![Software Installed by the Nephio Sandbox Installation](/static/images/install-guides/ManagementCluster.png)

# Components Installed on the VM Itself

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/install-on-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ git push

To check the status, use the console:

![Console Packages](/images/install-guides/gcp-console-packages.png)
![Console Packages](/static/images/install-guides/gcp-console-packages.png)

Alternatively, you can use `kubectl` to view the status of the `root-sync`:

Expand Down Expand Up @@ -1248,7 +1248,7 @@ ID START_TIME STATUS
You can now access the site via your browser, and will be asked to login as
shown below:

![Nephio Login Screen](/images/install-guides/install-guide-gcp-nephio-login.png)
![Nephio Login Screen](/static/images/install-guides/install-guide-gcp-nephio-login.png)


## Some Exercises
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 @@ -48,7 +48,7 @@ Nephio is establishing open, extensible Kubernetes Custom Resource Definition
(CRD) models for each layer of the stack, in conformance to the 3GPP & O-RAN
standards.

![nephio-overview.png](/images/user-guides/nephio-overview.png)
![nephio-overview.png](/static/images/user-guides/nephio-overview.png)

## Overview of Underlying Technologies

Expand Down Expand Up @@ -186,14 +186,14 @@ A package may have a single upstream parent, and many downstream descendants.
The Kptfiles in these packages are used to maintain the relationships, capturing
ancestry relationships like those shown below.

![package-ancestry.png](/images/user-guides/package-ancestry.png)
![package-ancestry.png](/static/images/user-guides/package-ancestry.png)

By tracking these relationships, changes at the original source can be
propagated via controlled automation down the tree.

### Package Configuration Journey

![package-lifecycle.png](/images/user-guides/package-lifecycle.png)
![package-lifecycle.png](/static/images/user-guides/package-lifecycle.png)

## R1 scope

Expand Down Expand Up @@ -240,7 +240,7 @@ For the purposes of Nephio deployment, we can categorize clusters into two varie

The diagram below depicts deployment at the high level.

![nephio-deployment.png](/images/user-guides/nephio-deployment.png)
![nephio-deployment.png](/static/images/user-guides/nephio-deployment.png)

### Management Cluster Components

Expand Down
40 changes: 20 additions & 20 deletions content/en/docs/guides/user-guides/exercise-1-free5gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ These exercises will take you from a system with only the Nephio Management clus

The network configuration is illustrated in the following figure:

![nephio-r1-5g-network.png](/images/user-guides/nephio-r1-5g-network.png)
![nephio-r1-5g-network.png](/static/images/user-guides/nephio-r1-5g-network.png)

Note that for simplicity, only one edge cluster is represented.

Expand Down Expand Up @@ -442,20 +442,20 @@ SMF, AMF, and UPF. For this, you will use the Regional cluster. Since these are
can use the UI to pick the `free5gc-cp` package from the `free5gc-packages` repository and clone it to the `regional`
repository (you could have also used the CLI).

![Install free5gc - Step 1](/images/user-guides/free5gc-cp-1.png)
![Install free5gc - Step 1](/static/images/user-guides/free5gc-cp-1.png)

![Install free5gc - Step 2](/images/user-guides/free5gc-cp-2.png)
![Install free5gc - Step 2](/static/images/user-guides/free5gc-cp-2.png)

![Install free5gc - Step 3](/images/user-guides/free5gc-cp-3.png)
![Install free5gc - Step 3](/static/images/user-guides/free5gc-cp-3.png)

Click through the "Next" button until you are through all the steps, then click "Add Deployment". On the next screen,
click "Propose", and then "Approve".

![Install free5gc - Step 4](/images/user-guides/free5gc-cp-4.png)
![Install free5gc - Step 4](/static/images/user-guides/free5gc-cp-4.png)

![Install free5gc - Step 5](/images/user-guides/free5gc-cp-5.png)
![Install free5gc - Step 5](/static/images/user-guides/free5gc-cp-5.png)

![Install free5gc - Step 6](/images/user-guides/free5gc-cp-6.png)
![Install free5gc - Step 6](/static/images/user-guides/free5gc-cp-6.png)

Shortly thereafter, you should see free5gc-cp in the cluster namespace:

Expand Down Expand Up @@ -992,46 +992,46 @@ edge01-40c616e5d87053350473d3ffa1387a9a534f8f42 free5gc-upf
Additionally you can check the Gitea edge01 repository (accessible at http://localhost:3000/nephio/edge01) for new
commits to see how Porch interacts with packages stored in Git repositories.

![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png)
![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).

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

![UPF Deployment](/images/user-guides/UPF-Capacity-2.png)
![UPF Deployment](/static/images/user-guides/UPF-Capacity-2.png)

![Inspecting Capacity.yaml file](/images/user-guides/UPF-Capacity-3.png)
![Inspecting Capacity.yaml file](/static/images/user-guides/UPF-Capacity-3.png)

![Throughput values](/images/user-guides/UPF-Capacity-4.png)
![Throughput values](/static/images/user-guides/UPF-Capacity-4.png)

Inside the package, you can see that the throughput values for UPF have been modified, reflecting the changes you made
with the CLI.

You can also scale NFs vertically using the Nephio Web UI. For practice you can scale the UPF on the second edge
cluster. Once again, navigate to the Web UI and choose the `edge02` repository in the Deployments section.

![Edge02 Deployments](/images/user-guides/UPF-Capacity-5.png)
![Edge02 Deployments](/static/images/user-guides/UPF-Capacity-5.png)

Select the `free5gc-upf` deployment, and then `View draft revision`.

![UPF Deployment in edge02](/images/user-guides/UPF-Capacity-6.png)
![UPF Deployment in edge02](/static/images/user-guides/UPF-Capacity-6.png)

![First revision](/images/user-guides/UPF-Capacity-7.png)
![First revision](/static/images/user-guides/UPF-Capacity-7.png)

Edit the draft revision, and modify the `Capacity.yaml` file.

![Edit the revision](/images/user-guides/UPF-Capacity-8.png)
![Edit the revision](/static/images/user-guides/UPF-Capacity-8.png)

![Capacity.yaml file](/images/user-guides/UPF-Capacity-9.png)
![Capacity.yaml file](/static/images/user-guides/UPF-Capacity-9.png)

![Throughput inside the file](/images/user-guides/UPF-Capacity-10.png)
![Throughput inside the file](/static/images/user-guides/UPF-Capacity-10.png)

![Propose the draft package](/images/user-guides/UPF-Capacity-11.png)
![Propose the draft package](/static/images/user-guides/UPF-Capacity-11.png)

After saving the changes to the file, propose the draft package and approve it.

![New revision](/images/user-guides/UPF-Capacity-12.png)
![New revision](/static/images/user-guides/UPF-Capacity-12.png)

After a few minutes, the revision for the UPF deployment will change, and the changes will be reflected in the `edge-02`
cluster.
4 changes: 2 additions & 2 deletions content/en/docs/guides/user-guides/exercise-2-oai.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ These exercises will take you from a system with only the Nephio Management clus

Above described deployment configuration is illustrated in the following figure:

![nephio-r2-deployment-diagram.png](/images/user-guides/nephio-r2-deployment-diagram.png)
![nephio-r2-deployment-diagram.png](/static/images/user-guides/nephio-r2-deployment-diagram.png)

The placement of Core and RAN network functions and the naming of the clouds is referred from O-RAN.WG6.CADS-v4.00 TR page 23.

The network configuration is illustrated in the following figure:

![nephio-r2-5g-network.png](/images/user-guides/nephio-r2-5g-network.png)
![nephio-r2-5g-network.png](/static/images/user-guides/nephio-r2-5g-network.png)

To perform these exercises, you will need:

Expand Down
20 changes: 10 additions & 10 deletions content/en/docs/guides/user-guides/helm/flux-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,22 @@ cluster.

* **Step 1**

![Install flux controllers - Step 1](/images/user-guides/nephio-ui-edge02-deployment.png)
![Install flux controllers - Step 1](/static/images/user-guides/nephio-ui-edge02-deployment.png)

* **Step 2**

![Install flux controllers - Step 2](/images/user-guides/add-deployment-selection.png)
![Install flux controllers - Step 2](/static/images/user-guides/add-deployment-selection.png)

* **Step 3**

![Install flux controllers - Step 3](/images/user-guides/flux-controller-selection.png)
![Install flux controllers - Step 3](/static/images/user-guides/flux-controller-selection.png)

Click through the `Next` button until you are through all the steps, leaving all options as `default`, then click
`Create Deployment`.

* **Step 4**

![Install flux controllers - Step 4](/images/user-guides/select-create-deployment.png)
![Install flux controllers - Step 4](/static/images/user-guides/select-create-deployment.png)

At this point, we can take a closer look at the contents of the kpt package which contains the relevant kubernetes
resources to deploy the controllers.
Expand All @@ -57,11 +57,11 @@ Finally, we need to `propose` and then `approve` the pkg to initialize the deplo

* **Step 5**

![Install flux controllers - Step 5](/images/user-guides/propose-selection.png)
![Install flux controllers - Step 5](/static/images/user-guides/propose-selection.png)

* **Step 6**

![Install flux controllers - Step 6](/images/user-guides/approve-selection.png)
![Install flux controllers - Step 6](/static/images/user-guides/approve-selection.png)

Shortly thereafter, you should see flux helm and source controllers in the flux-system namespace:

Expand Down Expand Up @@ -107,21 +107,21 @@ EOF
```
The new repository should now have been added to the `External Blueprints` section of the UI.

![External Blueprints UI](/images/user-guides/external-bp-repos.png)
![External Blueprints UI](/static/images/user-guides/external-bp-repos.png)

From here, we can see the onlineboutique-flux pkg to be deployed.

![online boutique pkg](/images/user-guides/nephio-pkgs-onlineboutique-show.png)
![online boutique pkg](/static/images/user-guides/nephio-pkgs-onlineboutique-show.png)

The HelmRepository Custom Resource within the kpt pkg refers to the official
[online boutique helm charts repo.](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/helm-chart)

![HelmRepo online boutique ref](/images/user-guides/helmrepo-onlineboutique-ref.png)
![HelmRepo online boutique ref](/static/images/user-guides/helmrepo-onlineboutique-ref.png)

To deploy the pkg, repeat/follow **Steps 1 - 6** from above, replacing **Step 3** with the following. Take note of the
source repo and the package to be deployed.

![Add acm pkg](/images/user-guides/add-deploy-onlinebout-select.png)
![Add acm pkg](/static/images/user-guides/add-deploy-onlinebout-select.png)

**_NOTE:_** The overrides online-boutique-values ConfigMap in the package refers to the default values.yaml for the
chart and can be customized prior to pkg approval.
Expand Down

0 comments on commit fa5ceee

Please sign in to comment.