Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md #353

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Update README.md #353

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@

[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/redhat.vscode-knative?style=for-the-badge&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-knative)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](https://github.com/redhat-developer/vscode-knative/blob/main/LICENSE)

> [!IMPORTANT]
> Developers are highly recommended to use the [OpenShift Toolkit](https://github.com/redhat-developer/vscode-openshift-tools) extension for `Knative Serverless Function` workflow to streamline their development process and ensure a seamless experience. All the latest features of Knative Serverless will be maintained in the OpenShift Toolkit extension, supported by Red Hat.

# Knative & Serverless Functions for Visual Studio Code

[Knative](https://knative.dev/docs/) is an Open-Source Enterprise-level solution to build Serverless and Event Driven Applications. Thus running Serverless Containers in Kubernetes environments.
[Knative](https://knative.dev/docs/) is an Open-Source Enterprise-level solution to build Serverless and Event-Driven Applications. Thus running Serverless Containers in Kubernetes environments.

This extension for Knative provides the app developer the tools and experience needed when working with `Knative & Serverless Functions` on a Kubernetes cluster. Using this extension, developers can develop and deploy functions in a serverless way through guided IDE workflow.
This extension for Knative provides the app developer with the tools and experience needed when working with `Knative & Serverless Functions` on a Kubernetes cluster. Using this extension, developers can develop and deploy functions in a serverless way through guided IDE workflow.

## Requirements

* Knative extension uses [kn cli](https://github.com/knative/client) `1.9.2` and [func cli](https://github.com/knative/func) `1.9.3`. The extension will offer to download and install the dependencies if needed.
* Knative extension uses [kn cli](https://github.com/knative/client) `1.13.0` and [func cli](https://github.com/knative/func) `1.13.0`. The extension will offer to download and install the dependencies if needed.

* YAML is validated using the [VSCode-YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension

* Users can log in to Kubernetes cluster using [VSCode Kubernetes extension](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-kubernetes-tools).
* Users can log in to the Kubernetes cluster using [VSCode Kubernetes extension](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-kubernetes-tools).

> NOTE: You will need to have the [kubeconfig](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#the-kubeconfig-environment-variable) for the cluster that you are accessing stored locally.

Expand All @@ -30,17 +32,17 @@ This extension contributes two views (Knative and Functions) and the following s

### Function Sessions

* This view is used to showcase Active command for a specified function. This includes Build, Deploy and Run sessions. Once the command is executed for a given function, the node is displayed in the Sessions View. Users can also `Stop` the executing action. The logs can be seen in the `Output Channel`.
* This view is used to showcase Active commands for a specified function. This includes Build, Deploy, and Run sessions. Once the command is executed for a given function, the node is displayed in the Sessions View. Users can also `Stop` the executing action. The logs can be seen in the `Output Channel`.

### Knative

* `service.explorer.create`: Create a new Knative service in the current namespace
* `service.explorer.openFile`: Display yaml for selected item
* `service.explorer.openFile`: Display YAML for the selected item
* `service.explorer.refresh`: Refresh the Explorer tree view

## Commands and features

`vscode-knative` supports a number of commands for interacting with Knative and Knative Functions; these are accessible via the tree context menu and/or via the command palette (`Cmd+Shift+P` <kbd>⌘⇧P</kbd> on macOS or `Ctrl+Shift+P` <kbd>⌃⇧P</kbd> on Windows and Linux)
`vscode-knative` supports several commands for interacting with Knative and Knative Functions; these are accessible via the tree context menu and via the command palette (`Cmd+Shift+P` <kbd>⌘⇧P</kbd> on macOS or `Ctrl+Shift+P` <kbd>⌃⇧P</kbd> on Windows and Linux)

### Functions

Expand All @@ -49,7 +51,7 @@ This extension contributes two views (Knative and Functions) and the following s
* `Knative: Run`: Runs the function locally in the current directory or in the directory specified
* `Knative: Deploy Function`: Deploys a function to the currently configured Knative-enabled cluster.
* `Knative: Undeploy`: Undeploys a function from the cluster.
* `Knative: Add Config to Function`: Allows configuration of Volume mounts, Environment variables for a function project
* `Knative: Add Config to Function`: Allows configuration of Volume mounts and environment variables for a function project
* `Knative: Remove Config from Function`: Remove Volume mounts, Environment variable from the function configuration
* `Knative: Open in Browser`: Open the deployed function in your browser
* `Knative: Refresh View`: Refresh the Function Tree View
Expand Down Expand Up @@ -77,15 +79,15 @@ This extension contributes two views (Knative and Functions) and the following s

## Contributing

This is an open source project open to anyone. We are always looking for contributions from the Function Developer community.
This is an open-source project open to anyone. We are always looking for contributions from the Function Developer community.

For information on getting started, refer to the [CONTRIBUTING instructions](CONTRIBUTING.md).
For information on getting started, please take a look at the [CONTRIBUTING instructions](CONTRIBUTING.md).

Download the most recent `knative-<version>.vsix` file from the [release](https://github.com/redhat-developer/vscode-knative/releases) and install it by following the instructions [here](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix). Stable releases are archived [here](https://download.jboss.org/jbosstools/adapters/stable/vscode-knative/).

## Feedback & Questions

If you discover an issue please file a bug and we will fix it as soon as possible.
If you find an issue, please file a bug and we will fix it as soon as possible.
* File a bug in [GitHub Issues](https://github.com/redhat-developer/vscode-knative/issues).
* Open a [Discussion on GitHub](https://github.com/redhat-developer/vscode-knative/discussions).

Expand Down
Loading