Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redhat-actions/kn-service-manager
GitHub Action to deploy a Knative Service using the Knative Client, kn.
https://github.com/redhat-actions/kn-service-manager
cloud deployment github-actions k8s kn knative openshift redhat serverless
Last synced: 3 months ago
JSON representation
GitHub Action to deploy a Knative Service using the Knative Client, kn.
- Host: GitHub
- URL: https://github.com/redhat-actions/kn-service-manager
- Owner: redhat-actions
- License: mit
- Created: 2020-12-15T10:06:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-07T13:53:13.000Z (over 2 years ago)
- Last Synced: 2024-09-16T23:18:02.434Z (5 months ago)
- Topics: cloud, deployment, github-actions, k8s, kn, knative, openshift, redhat, serverless
- Language: Shell
- Homepage: https://github.com/marketplace/actions/knative-service-manager
- Size: 61.5 KB
- Stars: 13
- Watchers: 6
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Knative Service Manager
[](https://github.com/redhat-actions/kn-service-manager/actions/workflows/ci.yml)
[](https://github.com/redhat-actions/kn-service-manager/actions/workflows/link_check.yml)
[](https://github.com/redhat-actions/kn-service-manager/tags)
[](./LICENSE)
**kn-service-manager** is a GitHub Action to manage [Knative Services](https://kn.dev) on a Kubernetes cluster, using the [Knative Client](https://github.com/knative/client).
## Prerequisites
A Kubernetes Cluster with [Knative installed](https://knative.dev/docs/install/). On OpenShift, this is usually provided through the [Red Hat OpenShift Serverless operator](https://www.openshift.com/learn/topics/serverless). To try an OpenShift cluster, visit [try.openshift.com](https://try.openshift.com).
## Action Inputs
| Input | Description | Default |
| ----- | ----------- | ------- |
| service_name | The name of the Knative service to create or manage. | **Required** |
| command | The command to pass to `kn`. Commands are `create`, `update`, `apply`, and `delete`. | create |
| container_image | The container image to deploy. Required unless command is `delete`. | None |
| force_create | If command is `create`, append the `--force` argument. | false |
| kn_extra_args | Any extra arguments to append to the `kn ` call. Refer to [Passing extra service arguments](#passing-extra-service-arguments). | None |
| namespace | Kubernetes namespace to target. | Current context |
| registry_user | The user to authenticate as to pull the `container_image`. Required if the image is private. | None
| registry_pasword | The `registry_user`'s password or token. Required if the image is private.| None |
**Note:**
When a username and a token or password are provided to pull the image, the action will create a Kubernetes `docker-registry` secret with the provided credentials. The secret's `docker-server` value will be the domain of the `container_image` input.
## Action Outputs
| Output | Description |
| ------ | ----------- |
| service_url | URL to the Knative service that was created or updated. Empty if `command` input is `delete`. |
## Example
The example below shows how the `kn-service-manager` action can be used to deploy a Knative service to Kubernetes.
You must be logged into your Kubernetes cluster before running this action. If you are using OpenShift, use [oc-login](https://github.com/redhat-actions/oc-login).
```yaml
- name: Create Knative Service
uses: redhat-actions/kn-service-manager@v1
with:
service_name: getting-started-knative
container_image: ${{ env.IMAGE_NAME }}
```
For a complete example see [the example workflow](./.github/workflows/example.yml).
## Passing extra service arguments
This action provides basic options such as namespace, service name, image and the command to run. There might be cases where you might want to pass extra arguments to the `kn service `. In those cases you can use `kn_extra_args`.
For example, if you want to add `--min-scale=1` and`--max-scale=5`, then your action snippet will be:
```yaml
- name: Create Knative Service
uses: redhat-actions/kn-service-manager@v1
with:
service_name: getting-started-knative
container_image: "${{ steps.push-to-quay.outputs.registry-path }}"
kn_extra_args: >
--min-scale=1
--max-scale=5
```