Skip to content
Merged
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
21 changes: 21 additions & 0 deletions content/en/docs/neo-porch/2_concepts/package-lifecycle.md
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.

![Flowchart](/static/images/porch/flowchart.drawio.svg)
6 changes: 4 additions & 2 deletions content/en/docs/neo-porch/4_tutorials_and_how-tos/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ weight: 4
description: Tutorials in Porch
---

## Lorem Ipsum
## Overview

Lorem Ipsum
{{% alert title="Note" color="primary" %}}
The tutorials in this section assume you have a local development environment running (Porch + Gitea in kind). If you plan to follow the walkthroughs locally, please set up the Local Dev Environment first. For more information, see [Local Development Environment Setup]({{% relref "/docs/neo-porch/6_configuration_and_deployments/deployments/local-dev-env-deployment.md" %}}).
{{% /alert %}}

This file was deleted.

Large diffs are not rendered by default.

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`
4 changes: 4 additions & 0 deletions static/images/porch/flowchart.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions static/images/porch/upgrade-step1.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions static/images/porch/upgrade-step2.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions static/images/porch/upgrade-step3.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions static/images/porch/upgrade-step4.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions static/images/porch/upgrade.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading