Skip to content

Commit

Permalink
docs: add crds.dev link to visualize current CRD
Browse files Browse the repository at this point in the history
Signed-off-by: Mario Constanti <mario.constanti@mercedes-benz.com>
  • Loading branch information
bavarianbidi committed Oct 4, 2023
1 parent 7c2a1b2 commit f8af2fd
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Feature Request
description: Request a feature you want to see in garm operator
body:
- type: textarea
id: feature
attributes:
label: What is the feature you would like to have?
description: |
Please provide as much info as possible about the feature.
placeholder: "I would like to have ..."
validations:
required: true

- type: textarea
id: additional
attributes:
label: Anything else you would like to add?
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<!-- SPDX-License-Identifier: MIT -->

[![Go Report Card](https://goreportcard.com/badge/github.com/mercedes-benz/garm-operator)](https://goreportcard.com/report/github.com/mercedes-benz/garm-operator) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mercedes-benz/garm-operator?sort=semver)
[![Go Report Card](https://goreportcard.com/badge/github.com/mercedes-benz/garm-operator)](https://goreportcard.com/report/github.com/mercedes-benz/garm-operator)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/mercedes-benz/garm-operator?sort=semver)
[![build](https://github.com/mercedes-benz/garm-operator/actions/workflows/build.yml/badge.svg)](https://github.com/mercedes-benz/garm-operator/actions/workflows/build.yml)

# garm-operator

Expand Down Expand Up @@ -55,7 +57,7 @@ We are releasing the `garm-operator` as container image together with the corres
This manifests can be used to deploy the `garm-operator` into your Kubernetes cluster.

```bash
export GARM_OPERATOR_VERSIOn=<garm-operator-version>
export GARM_OPERATOR_VERSION=<garm-operator-version>
export GARM_SERVER_URL=<garm-server-url>
export GARM_SERVER_USERNAME=<garm-server-username>
export GARM_SERVER_PASSWORD=<garm-server-password>
Expand All @@ -64,6 +66,8 @@ curl -L https://github.com/mercedes-benz/garm-operator/releases/download/${GARM_

#### Custom Resources

The CRD documentation can be also seen via [docs.crds.dev](https://doc.crds.dev/github.com/mercedes-benz/garm-operator).

Folder `config/samples` contains few basic examples of `Pools`, `Images` and corresponding `Repositories`, `Organizations` or `Enterprises`.

## 💻 Development
Expand Down

0 comments on commit f8af2fd

Please sign in to comment.