Minimal install #69
Merged
Minimal install #69
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit creates the Nephio developer-guide subdirectory and starts the developer guide with instructions on how to do a minimal local install. This minimal install is enough to get the Nephio operators running in vscode towards a local Kind cluster with the minimal Nephio dependencies installed there. Signed-off-by: liamfallon <liam.fallon@est.tech>
This commit creates the Nephio developer-guide subdirectory and starts the developer guide with instructions on how to do a minimal local install. This minimal install is enough to get the Nephio operators running in vscode towards a local Kind cluster with the minimal Nephio dependencies installed there. Signed-off-by: liamfallon <liam.fallon@est.tech>
|
/assign @electrocucaracha @efiacor @lapentad |
developer-guide/README.md
Outdated
| Nephio Developer Guide | ||
| ====================== | ||
|
|
||
| The developer guide is for anyone wanting to either write code for the Nephio project. THis document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. |
There was a problem hiding this comment.
Suggested change
| The developer guide is for anyone wanting to either write code for the Nephio project. THis document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. | |
| The developer guide is for anyone wanting to either write code for the Nephio project. This document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. |
developer-guide/README.md
Outdated
|
|
||
| The developer guide is for anyone wanting to either write code for the Nephio project. THis document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project) and therefore covers topics that are specific to Nephio development. | ||
|
|
||
| * How to set up a [Minimal Development Environment]minimal-environment.md) defines common terminology used in the Nephio project. |
There was a problem hiding this comment.
Suggested change
| * How to set up a [Minimal Development Environment]minimal-environment.md) defines common terminology used in the Nephio project. | |
| * How to set up a [Minimal Development Environment](minimal-environment.md) defines common terminology used in the Nephio project. |
developer-guide/minimal-environment
Outdated
| Minimal Environment install for development | ||
| =========================================== | ||
|
|
||
| The following environment install works on a Macbook Pro M1 to get the nephio-operators running in vscode talking to a local kind cluster running in Docker. Note that depending on what aprt of Nephio you are working on, you may wish to install less or more of the components below. It should work on other environments with appropriate tweaking. |
There was a problem hiding this comment.
Suggested change
| The following environment install works on a Macbook Pro M1 to get the nephio-operators running in vscode talking to a local kind cluster running in Docker. Note that depending on what aprt of Nephio you are working on, you may wish to install less or more of the components below. It should work on other environments with appropriate tweaking. | |
| The following environment install works on a Macbook Pro M1 to get the nephio-operators running in vscode talking to a local kind cluster running in Docker. Note that depending on what part of Nephio you are working on, you may wish to install less or more of the components below. It should work on other environments with appropriate tweaking. |
developer-guide/minimal-environment
Outdated
|
|
||
| ## Installation steps: | ||
|
|
||
| 1. Install Docker using the appropriate method for you system. |
There was a problem hiding this comment.
Suggested change
| 1. Install Docker using the appropriate method for you system. | |
| 1. [Install Docker](https://docs.docker.com/engine/install/) using the appropriate method for you system. |
developer-guide/minimal-environment
Outdated
|
|
||
| 1. Install Docker using the appropriate method for you system. | ||
|
|
||
| 2. Install kind using the appropriate method for you system (homebrew on mac) |
There was a problem hiding this comment.
Suggested change
| 2. Install kind using the appropriate method for you system (homebrew on mac) | |
| 2. [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) using the appropriate method for you system (homebrew on mac) |
developer-guide/minimal-environment
Outdated
Comment on lines
43
to
45
| ```sh | ||
| brew install kind | ||
| ``` |
There was a problem hiding this comment.
Providing a pointer to the kind installation, the following instruction can be omitted
Suggested change
| ```sh | |
| brew install kind | |
| ``` |
developer-guide/minimal-environment
Outdated
|
|
||
| # Connect to Gitea on your browser | ||
|
|
||
| COnnecting to Gitea allows you to see the actions that Nephio takes on Gitea. |
There was a problem hiding this comment.
Suggested change
| COnnecting to Gitea allows you to see the actions that Nephio takes on Gitea. | |
| Connecting to Gitea allows you to see the actions that Nephio takes on Gitea. |
|
@electrocucaracha thanks for the review and sorry for all the typos. |
|
/lgtm |
tomkivlin
reviewed
Oct 31, 2023
developer-guide/minimal-environment
Outdated
| 1. [Install Docker](https://docs.docker.com/engine/install/) using the appropriate method for you system. | ||
|
|
||
| 2. [Install kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) using the appropriate method for you system (homebrew on mac) | ||
|
|
There was a problem hiding this comment.
I think a step is needed here to install kpt - it's not included in the referenced Kubernetes local development guide so should be here, I think.
There was a problem hiding this comment.
e.g.
3. [Install kpt cli](https://kpt.dev/installation/kpt-cli) using the appropriate method for your system (e.g. homebrew on mac)
There was a problem hiding this comment.
I added this step, thanks @tomkivlin for the review.
tomkivlin
reviewed
Oct 31, 2023
tomkivlin
reviewed
Oct 31, 2023
tomkivlin
reviewed
Oct 31, 2023
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
|
/approve |
|
/approve Nice! |
|
@liamfallon thanks a lot. This requires a rebase before merging. |
efiacor
reviewed
Nov 2, 2023
| Minimal Environment install for development | ||
| =========================================== | ||
|
|
||
| The following environment install works on a Macbook Pro M1 or via SSH to Ubuntu 22.04 to get the nephio-operators running in vscode talking to a local kind cluster running in Docker. Note that depending on what part of Nephio you are working on, you may wish to install less or more of the components below. It should work on other environments with appropriate tweaking. |
There was a problem hiding this comment.
Do we need a dev machine spec table?
There was a problem hiding this comment.
Maybe later, I don't think we need it right now.
This commit creates the Nephio developer-guide subdirectory and starts the developer guide with instructions on how to do a minimal local install. This minimal install is enough to get the Nephio operators running in vscode towards a local Kind cluster with the minimal Nephio dependencies installed there. Signed-off-by: liamfallon <liam.fallon@est.tech>
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
Co-authored-by: Tom Kivlin <52716470+tomkivlin@users.noreply.github.com>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: efiacor, gvbalaji, johnbelamaric, lapentad The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Can I get a LGTM on this please? |
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.