-
Notifications
You must be signed in to change notification settings - Fork 36
Upgrade examples on the new docs #275
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.
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 16 commits into
nephio-project:main
from
Nordix:tutorial-upgrades-section
Nov 24, 2025
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
85b2a82
Update content for upgrading packages documentation
lapentad 143118b
upgrade examples
lapentad 7fba00e
Fix typo in link
lapentad 03d78c5
reordered and added examples
lapentad d539552
fix path error
lapentad 1a0ff99
moving the svg and fix link
lapentad bdda058
address comments and added upgrade svg
lapentad d4afb9a
removed unused images
lapentad d3b5479
resolve link issue moving images
lapentad dd0a1a9
better schemas and tables
lapentad 663cf36
qtypo
lapentad ca86066
use case
lapentad f52560b
added step-by-step schema
lapentad ce58ed6
css style for table
lapentad 8720bde
alert style
lapentad fef75ca
linkinspector links fix
lapentad File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: "Package Lifecycle" | ||
| type: docs | ||
| weight: 3 | ||
| description: | ||
| --- | ||
|
|
||
| ## Package Lifecycle Workflow | ||
|
|
||
| Packages managed by Porch progress through several states, from creation to final publication. This workflow ensures that packages are reviewed and approved before they are published and consumed. | ||
|
|
||
| The typical lifecycle of a package is as follows: | ||
|
|
||
| 1. **Draft:** A user initializes a new package or clones an existing one. The package is in a `Draft` state, allowing the user to make changes freely in their local workspace. | ||
| 2. **Proposed:** Once the changes are ready for review, the user pushes the package, which transitions it to the `Proposed` state. In this stage, the package is available for review by other team members. | ||
| 3. **Review and Approval:** | ||
| * **Approved:** If the package is approved, it is ready to be published. | ||
| * **Rejected:** If changes are required, the package is rejected. The user must pull the package, make the necessary modifications, and re-propose it for another review. | ||
| 4. **Published:** After approval, the package is published. Published packages are considered stable and are available for deployment and consumption by other systems or clusters. They typically become the "latest" version of a package. | ||
|
|
||
|  |
This file contains hidden or 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
10 changes: 0 additions & 10 deletions
10
content/en/docs/neo-porch/4_tutorials_and_how-tos/package-lifecycle.md
This file was deleted.
Oops, something went wrong.
353 changes: 344 additions & 9 deletions
353
content/en/docs/neo-porch/4_tutorials_and_how-tos/upgrading-packages.md
Large diffs are not rendered by default.
Oops, something went wrong.
89 changes: 85 additions & 4 deletions
89
...o-porch/6_configuration_and_deployments/deployments/local-dev-env-deployment.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,91 @@ | ||
| --- | ||
| title: "Local/Development Environment Deployment" | ||
| title: "Local Development Environment Setup" | ||
| type: docs | ||
| weight: 3 | ||
| description: | ||
| description: "A guide to setting up a local environment for developing and testing with Porch." | ||
| --- | ||
|
|
||
| ## Lorem Ipsum | ||
| # Local Development Environment Setup | ||
|
|
||
| this section should only explain setting up the dev environment (not how to use it) [example old guide]({{% relref "/docs/neo-porch/6_configuration_and_deployments/relevant_old_docs/environment-setup.md" %}}) | ||
| This guide provides instructions for setting up a local development environment using `kind` (Kubernetes in Docker). This setup is ideal for developing, testing, and exploring Porch functionalities. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Prerequisites](#prerequisites) | ||
| - [Local Environment Setup](#local-environment-setup) | ||
| - [Verifying the Setup](#verifying-the-setup) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, ensure you have the following tools installed on your system: | ||
|
|
||
| * **[Docker](https://docs.docker.com/get-docker/):** For running containers, including the `kind` cluster. | ||
| * **[kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/):** The Kubernetes command-line tool for interacting with your cluster. | ||
| * **[kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation):** A tool for running local Kubernetes clusters using Docker container "nodes". | ||
|
|
||
| The setup scripts provided in the Porch repository will handle the installation of Porch itself and its CLI, `porchctl`. | ||
|
|
||
| ## Local Environment Setup | ||
|
|
||
| Follow these steps from the root directory of your cloned Porch repository to set up your local environment. | ||
|
|
||
| 1. **Bring up the `kind` cluster:** | ||
|
|
||
| This script creates a local Kubernetes cluster with the necessary configuration for Porch. | ||
|
|
||
| ```bash | ||
| ./scripts/setup-dev-env.sh | ||
| ``` | ||
|
|
||
| 2. **Build and load Porch images:** | ||
|
|
||
| **Choose one of the following options** to build the Porch container images and load them into your `kind` cluster. | ||
|
|
||
| * **CR-CACHE (Default):** Uses a cache backed by a Custom Resource (CR). | ||
| ```bash | ||
| make run-in-kind | ||
| ``` | ||
|
|
||
| * **DB-CACHE:** Uses a PostgreSQL database as the cache backend. | ||
| ```bash | ||
| make run-in-kind-db-cache | ||
| ``` | ||
|
|
||
| ## Verifying the Setup | ||
|
|
||
| After the setup scripts complete, verify that all components are running correctly. | ||
|
|
||
| 1. **Check Pod Status:** | ||
|
|
||
| Ensure all pods in the `porch-system` namespace are in the `READY` state. | ||
|
|
||
| ```bash | ||
| kubectl get pods -n porch-system | ||
| ``` | ||
|
|
||
| 2. **Verify CRD Availability:** | ||
|
|
||
| Confirm that the `PackageRevision` Custom Resource Definition (CRD) has been successfully registered. | ||
|
|
||
| ```bash | ||
| kubectl api-resources | grep packagerevisions | ||
| ``` | ||
|
|
||
| 3. **Configure `porchctl` (Optional):** | ||
|
|
||
| The `porchctl` binary is built into the `.build/` directory. For convenient access, add it to your system's `PATH`. | ||
|
|
||
| ```bash | ||
| # You can copy the binary to a directory in your PATH, for example: | ||
| sudo cp ./.build/porchctl /usr/local/bin/porchctl | ||
|
|
||
| # Alternatively, you can add the build directory to your PATH: | ||
| export PATH="$(pwd)/.build:$PATH" | ||
| ``` | ||
|
|
||
| 4. **Access Gitea UI (Optional):** | ||
|
|
||
| The local environment includes a Gitea instance for Git repository hosting. You can access it at [http://localhost:3000](http://localhost:3000). | ||
|
|
||
| * **Username:** `nephio` | ||
| * **Password:** `secret` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.