Skip to content

Update Sandbox R2 documentation #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nephio-prow merged 1 commit into from
Jan 29, 2024
Merged

Update Sandbox R2 documentation #95

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 7 additions & 25 deletions content/en/docs/guides/install-guides/install-on-single-vm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In addition to the general prerequisites, you will need:

* Access to a Virtual Machine provided by an hypervisor ([VirtualBox](https://www.virtualbox.org/),
[Libvirt](https://libvirt.org/)) and running an OS supported by Nephio (Ubuntu 20.04/22.04, Fedora 34) with a minimum
of 8 vCPUs and 8 GB in RAM.
of 16 vCPUs and 32 GB in RAM.
* [Kubernetes IN Docker](https://kind.sigs.k8s.io/) (`kind`) installed and set up your workstation.

## Provisioning Your Management Cluster
Expand All @@ -51,29 +51,11 @@ EOF

## Gitea Installation

While you may use other Git providers as well, Gitea is required in the R1 setup. To install Gitea, use `kpt`. From your
While you may use other Git providers as well, Gitea is required in the R2 setup. To install Gitea, use `kpt`. From your
`nephio-install` directory, run:

Gitea package has services that use frontend and database services, these services require authentication information.
This information needs to be created as secret resources that belong to the `gitea` namespace.

```bash
kubectl create namespace gitea
kubectl create secret generic gitea-postgresql -n gitea \
--from-literal=postgres-password=secret \
--from-literal=password=secret
kubectl label secret -n gitea gitea-postgresql app.kubernetes.io/name=postgresql
kubectl label secret -n gitea gitea-postgresql app.kubernetes.io/instance=gitea
kubectl create secret generic git-user-secret -n gitea \
--type='kubernetes.io/basic-auth' \
--from-literal=username=nephio \
--from-literal=password=secret
```

Once those resources are created, you can proceed to install the gitea package.

```bash
kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages/gitea@v1.0.1
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/distros/sandbox/gitea@v2.0.0
Copy link
Contributor

@lapentad lapentad Jan 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "@v2.0.0" supposing there is going to be a tag v2 after release in catalog?
/approve

kpt fn render gitea
kpt live init gitea
kpt live apply gitea --reconcile-timeout 15m --output=table
Expand All @@ -97,7 +79,7 @@ For managing the Kubernetes cluster infrastructure, it is necessary to install
[cert-manager project](https://cert-manager.io/) to generate certificates.

```bash
kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages/cert-manager@v1.0.1
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/distros/sandbox/cert-manager@v2.0.0
kpt fn render cert-manager
kpt live init cert-manager
kpt live apply cert-manager --reconcile-timeout 15m --output=table
Expand All @@ -106,7 +88,7 @@ kpt live apply cert-manager --reconcile-timeout 15m --output=table
Once `cert-manager` is installed, you can proceed with the installation of Cluster API components

```bash
kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages/cluster-capi@v1.0.1
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/infra/capi/cluster-capi@v2.0.0
kpt fn render cluster-capi
kpt live init cluster-capi
kpt live apply cluster-capi --reconcile-timeout 15m --output=table
Expand All @@ -116,7 +98,7 @@ Cluster API uses infrastructure providers to provision cloud resources required
resources with the Docker provider, it can be installed with the followed package.

```bash
kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages/cluster-capi-infrastructure-docker@v1.0.1
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/infra/capi/cluster-capi-infrastructure-docker@v2.0.0
kpt fn render cluster-capi-infrastructure-docker
kpt live init cluster-capi-infrastructure-docker
kpt live apply cluster-capi-infrastructure-docker --reconcile-timeout 15m --output=table
Expand All @@ -127,7 +109,7 @@ machines. These templates define the kubelet args, etcd and coreDNS configuratio


```bash
kpt pkg get --for-deployment https://github.com/nephio-project/nephio-example-packages/cluster-capi-kind-docker-templates@v1.0.1
kpt pkg get --for-deployment https://github.com/nephio-project/catalog.git/infra/capi/cluster-capi-kind-docker-templates@v2.0.0
kpt fn render cluster-capi-kind-docker-templates
kpt live init cluster-capi-kind-docker-templates
kpt live apply cluster-capi-kind-docker-templates --reconcile-timeout 15m --output=table
Expand Down