https://github.com/cah4a/rekube

React renderer for Kubernetes configurations
https://github.com/cah4a/rekube

kubernetes kubernetes-deployment react react-renderer reactjs

Last synced: 3 months ago
JSON representation

React renderer for Kubernetes configurations

• Host: GitHub
• URL: https://github.com/cah4a/rekube
• Owner: cah4a
• License: apache-2.0
• Created: 2023-06-03T15:33:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-11T07:52:03.000Z (9 months ago)
• Last Synced: 2024-08-13T08:23:27.787Z (4 months ago)
• Topics: kubernetes, kubernetes-deployment, react, react-renderer, reactjs
• Language: TypeScript
• Homepage:
• Size: 872 KB
• Stars: 22
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RE:KUBE PROJECT

React renderer for Kubernetes configurations.  

JSX instead of clumsy YAML, declarative and type-safe configurations.

## Why Rekube?

1. **Leverage programming:**  

   Use variables, functions, type-safety, conditional rendering, etc.

2. **Leverage React:**  

   Context aware configurations, Reusable components, Package ecosystem

## Before you start

Install [node](https://nodejs.org/en/download) if you don't have it already.

As option, install one of the following package managers:

- [yarn](https://yarnpkg.com/getting-started/install)

- [pnpm](https://pnpm.io/installation)

## Getting started

1. Init the project

   ```bash

   mkdir /your/project

   cd /your/project

   npm init # You could use pnpm or yarn if you prefer

   ```

2. Add Rekube base components package to the project:

   

   ```bash

   npm install -D rekube @rekube/base

   ```

   

   or

   ```bash

   pnpm install -D rekube @rekube/base

   yarn add -D rekube @rekube/base

   ```

3. Create a file `k8s.tsx` with the following content:

   ```tsx

   import { Deployment } from "@rekube/base/apps/v1";

   import { Container, ContainerPort, PodTemplateSpec, Service, ServicePort } from "@rekube/base/core/v1";

   

   export default function App() {

       const labels = { app: "nginx" };

   

       return (

           <>

               

                   

                       

                           

                       

                   

               

   

               

                   

               

           >

       );

   }

   ```

4. Run `rekube` cli in the project directory.

   It will render the k8s.tsx file to stdout:

   ```bash

   npx rekube

   npx rekube ./other/file.tsx

   npx rekube > k8s.yaml

   ```

   

   or pipe it directly to kubectl:

   ```bash

   npx rekube | kubectl apply -f -

   ```

## Publishing your Rekube packages on npm

Rekube utilizes the npm ecosystem.  

You can publish your Rekube components just like [any other npm package](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages).  

Moreover, Rebuke includes a built-in transpiler that enables you to directly publish `tsx/jsx` files.

## Generating Rekube Components out of yaml file

Rekube includes a built-in transpiler that enables you to directly convert `yaml` files to `tsx` files.

```bash

npx rekube convert ./path/to/your/file.yaml

```

## Contributing

Any contribution is welcome. Either it's a bug report, a feature request, or a pull request.

Reach me out if you have any questions or need help with anything.