mirror of https://github.com/knative/docs.git
Format markdown (#1070)
* Format markdown Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)` * Apply suggestions from code review Co-Authored-By: mattmoor-sockpuppet <mattmoor+sockpuppet@google.com> * Undo parts of auto-correction that result in diff.
This commit is contained in:
parent
9910b8a9ac
commit
01d4ba31ec
|
@ -7,8 +7,8 @@ docs and learn about Knative.
|
||||||
|
|
||||||
## Source files
|
## Source files
|
||||||
|
|
||||||
View the source files if you want to contribute a fix or add new content.
|
View the source files if you want to contribute a fix or add new content. Each
|
||||||
Each release of the Knative docs are
|
release of the Knative docs are
|
||||||
[branched](https://github.com/knative/docs/branches). If you are looking for an
|
[branched](https://github.com/knative/docs/branches). If you are looking for an
|
||||||
archived doc set, see the list of available versions in
|
archived doc set, see the list of available versions in
|
||||||
[Knative doc releases](./doc-releases.md).
|
[Knative doc releases](./doc-releases.md).
|
||||||
|
|
|
@ -7,7 +7,6 @@ menu:
|
||||||
type: "blog"
|
type: "blog"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
Welcome to the Knative **blog** section. Keep up-to-date with product and
|
Welcome to the Knative **blog** section. Keep up-to-date with product and
|
||||||
release announcements, read articles, hear about recent social events, and
|
release announcements, read articles, hear about recent social events, and find
|
||||||
find out where the Knative team will be talking next.
|
out where the Knative team will be talking next.
|
||||||
|
|
|
@ -4,4 +4,3 @@ linkTitle: "Articles"
|
||||||
weight: 30
|
weight: 30
|
||||||
type: "blog"
|
type: "blog"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
## Sample apps
|
## Sample apps
|
||||||
|
|
||||||
| Sample Name | Knative Component | Description | Language(s) |
|
| Sample Name | Knative Component | Description | Language(s) |
|
||||||
| --------------| ----------------- | -------------------------- | ----------------- |
|
| ----------- | ----------------- | ---------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
|
| Hello World | Serving | A quick introduction that highlights how to deploy an app. | [Clojure](./serving/helloworld-clojure/README.md), [Dart](./serving/helloworld-dart/README.md), [Elixir](./serving/helloworld-elixir/README.md), [Haskell](./serving/helloworld-haskell/README.md), [Rust](./serving/helloworld-rust/README.md), [Shell](./serving/helloworld-shell/README.md), [Swift](./serving/helloworld-swift/README.md), [Vertx](./serving/helloworld-vertx/README.md) |
|
||||||
|
|
|
@ -8,6 +8,7 @@ type: "docs"
|
||||||
Get up and running in a language of your choice using one of the community
|
Get up and running in a language of your choice using one of the community
|
||||||
contributed and maintained sample apps.
|
contributed and maintained sample apps.
|
||||||
|
|
||||||
Use the following table to view the instructions and sample code in the knative/docs repo.
|
Use the following table to view the instructions and sample code in the
|
||||||
|
knative/docs repo.
|
||||||
|
|
||||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||||
|
|
|
@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -8,8 +8,8 @@ that you can use for testing. It reads in the env variable `TARGET` and prints
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- [dart-sdk](https://www.dartlang.org/tools/sdk#install) installed and
|
- [dart-sdk](https://www.dartlang.org/tools/sdk#install) installed and
|
||||||
|
|
|
@ -7,8 +7,8 @@ specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -8,8 +8,8 @@ TARGET is not specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -7,8 +7,8 @@ variable is not specified, the script uses `World`.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -15,8 +15,8 @@ You must meet the following requirements to complete this sample:
|
||||||
|
|
||||||
- A version of the Knative Serving component installed and running on your
|
- A version of the Knative Serving component installed and running on your
|
||||||
Kubernetes cluster. Follow the
|
Kubernetes cluster. Follow the
|
||||||
[Knative installation instructions](../../../install/README.md)
|
[Knative installation instructions](../../../install/README.md) if you need to
|
||||||
if you need to create a Knative cluster.
|
create a Knative cluster.
|
||||||
- The following software downloaded and install on your loacal machine:
|
- The following software downloaded and install on your loacal machine:
|
||||||
- [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
|
- [Java SE 8 or later JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
|
||||||
- [Eclipse Vert.x v3.5.4](https://vertx.io/).
|
- [Eclipse Vert.x v3.5.4](https://vertx.io/).
|
||||||
|
|
|
@ -86,8 +86,8 @@ page still applies, but you'll find the specifics about the docs process there.
|
||||||
In order to contribute a feature to Knative you'll need to go through the
|
In order to contribute a feature to Knative you'll need to go through the
|
||||||
following steps:
|
following steps:
|
||||||
|
|
||||||
- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md) on
|
- Discuss your idea with the appropriate [working groups](./WORKING-GROUPS.md)
|
||||||
the working group's mailing list.
|
on the working group's mailing list.
|
||||||
|
|
||||||
- Once there is general agreement that the feature is useful,
|
- Once there is general agreement that the feature is useful,
|
||||||
[create a GitHub issue](https://github.com/knative/docs/issues/new) to track
|
[create a GitHub issue](https://github.com/knative/docs/issues/new) to track
|
||||||
|
|
|
@ -53,7 +53,6 @@ Note that code issues should be filed against the
|
||||||
[individual Knative repositories](http://github.com/knative), while
|
[individual Knative repositories](http://github.com/knative), while
|
||||||
documentation issues should go in the `docs` repository.
|
documentation issues should go in the `docs` repository.
|
||||||
|
|
||||||
|
|
||||||
### Working group
|
### Working group
|
||||||
|
|
||||||
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation)
|
The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation)
|
||||||
|
@ -112,8 +111,8 @@ that are only expected to be used by contributors, those samples are put in the
|
||||||
## Docs contributor roles
|
## Docs contributor roles
|
||||||
|
|
||||||
Because contributing to the documentation requires a different skill set than
|
Because contributing to the documentation requires a different skill set than
|
||||||
contributing to the Knative code base, we've defined the roles of
|
contributing to the Knative code base, we've defined the roles of documentation
|
||||||
documentation contributors seperately from the roles of code contributors.
|
contributors seperately from the roles of code contributors.
|
||||||
|
|
||||||
If you're looking for code contributor roles, see [ROLES](./ROLES.md).
|
If you're looking for code contributor roles, see [ROLES](./ROLES.md).
|
||||||
|
|
||||||
|
@ -122,21 +121,21 @@ If you're looking for code contributor roles, see [ROLES](./ROLES.md).
|
||||||
Established contributor to the Knative docs.
|
Established contributor to the Knative docs.
|
||||||
|
|
||||||
Members are continuously active contributors in the community. They can have
|
Members are continuously active contributors in the community. They can have
|
||||||
issues and PRs assigned to them, might participate in working group meetings, and
|
issues and PRs assigned to them, might participate in working group meetings,
|
||||||
pre-submit tests are automatically run for their PRs. Members are expected to
|
and pre-submit tests are automatically run for their PRs. Members are expected
|
||||||
remain active contributors to the Knative documentation.
|
to remain active contributors to the Knative documentation.
|
||||||
|
|
||||||
All members are encouraged to help with PR reviews, although each PR
|
All members are encouraged to help with PR reviews, although each PR must be
|
||||||
must be reviewed by an official [Approver](#approver). In their review,
|
reviewed by an official [Approver](#approver). In their review, members should
|
||||||
members should be looking for technical correctness of the documentation,
|
be looking for technical correctness of the documentation, adherence to the
|
||||||
adherence to the [style guide](https://developers.google.com/style/), good spelling and grammar (writing quality),
|
[style guide](https://developers.google.com/style/), good spelling and grammar
|
||||||
intuitive organization, and strong documentation usability. Members should be
|
(writing quality), intuitive organization, and strong documentation usability.
|
||||||
proficient in at least one of these review areas.
|
Members should be proficient in at least one of these review areas.
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
- Has made multiple contributions to the project or community. Contributions might
|
- Has made multiple contributions to the project or community. Contributions
|
||||||
include, but are not limited to:
|
might include, but are not limited to:
|
||||||
|
|
||||||
- Authoring and reviewing PRs on GitHub in the Docs or Website repos.
|
- Authoring and reviewing PRs on GitHub in the Docs or Website repos.
|
||||||
|
|
||||||
|
@ -157,42 +156,45 @@ proficient in at least one of these review areas.
|
||||||
|
|
||||||
- Responsive to issues and PRs assigned to them.
|
- Responsive to issues and PRs assigned to them.
|
||||||
|
|
||||||
- Active owner of documents they have contributed (unless ownership is explicitly
|
- Active owner of documents they have contributed (unless ownership is
|
||||||
transferred).
|
explicitly transferred).
|
||||||
|
|
||||||
- Addresses bugs or issues in their documentation in a timely manner.
|
- Addresses bugs or issues in their documentation in a timely manner.
|
||||||
|
|
||||||
### Becoming a member
|
### Becoming a member
|
||||||
|
|
||||||
First, reach out to an approver and ask them to sponsor you so that you can become a member.
|
First, reach out to an approver and ask them to sponsor you so that you can
|
||||||
The easiest way to do this is using Slack.
|
become a member. The easiest way to do this is using Slack.
|
||||||
|
|
||||||
If they are supportive of your membership, your sponsor will reach out to the Knative Steering
|
If they are supportive of your membership, your sponsor will reach out to the
|
||||||
committee to ask that you be added as a member of the Knative org.
|
Knative Steering committee to ask that you be added as a member of the Knative
|
||||||
|
org.
|
||||||
|
|
||||||
Once your sponsor notifies you that you've been added to the Knative org,
|
Once your sponsor notifies you that you've been added to the Knative org, open a
|
||||||
open a PR to add yourself as a docs-reviewer in the
|
PR to add yourself as a docs-reviewer in the [OWNERS_ALIASES](../OWNERS_ALIASES)
|
||||||
[OWNERS_ALIASES](../OWNERS_ALIASES) file.
|
file.
|
||||||
|
|
||||||
## Approver
|
## Approver
|
||||||
|
|
||||||
Docs approvers are able to both review and approve documentation contributions.
|
Docs approvers are able to both review and approve documentation contributions.
|
||||||
While documentation review is focused on writing quality and correctness,
|
While documentation review is focused on writing quality and correctness,
|
||||||
approval is focused on holistic acceptance of a contribution including:
|
approval is focused on holistic acceptance of a contribution including:
|
||||||
long-term maintainability, adhering to style guide conventions, overall information
|
long-term maintainability, adhering to style guide conventions, overall
|
||||||
architecture, and usability from an engineering standpoint. Docs approvers will
|
information architecture, and usability from an engineering standpoint. Docs
|
||||||
enlist help from engineers for reviewing code-heavy contributions to the Docs repo.
|
approvers will enlist help from engineers for reviewing code-heavy contributions
|
||||||
|
to the Docs repo.
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
- Reviewer of the Docs repo for at least 3 months.
|
- Reviewer of the Docs repo for at least 3 months.
|
||||||
|
|
||||||
- Proficient in reviewing all aspects of writing quality, including grammar and
|
- Proficient in reviewing all aspects of writing quality, including grammar
|
||||||
spelling, adherence to style guide conventions, organization, and usability.
|
and spelling, adherence to style guide conventions, organization, and
|
||||||
Can coach newer writers to improve their contributions in these areas.
|
usability. Can coach newer writers to improve their contributions in these
|
||||||
|
areas.
|
||||||
|
|
||||||
- Primary reviewer for at least 10 substantial PRs to the docs, showing substantial
|
- Primary reviewer for at least 10 substantial PRs to the docs, showing
|
||||||
ability to coach for writing development.
|
substantial ability to coach for writing development.
|
||||||
|
|
||||||
- Reviewed or merged at least 30 PRs to the docs.
|
- Reviewed or merged at least 30 PRs to the docs.
|
||||||
|
|
||||||
|
@ -204,9 +206,9 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
|
||||||
|
|
||||||
- Responsible for documentation quality control via PR reviews.
|
- Responsible for documentation quality control via PR reviews.
|
||||||
|
|
||||||
- Focus on long-term maintainability, adhering to style
|
- Focus on long-term maintainability, adhering to style guide conventions,
|
||||||
guide conventions, overall information architecture, and usability from
|
overall information architecture, and usability from an engineering
|
||||||
an engineering standpoint.
|
standpoint.
|
||||||
|
|
||||||
- Expected to be responsive to review requests as per
|
- Expected to be responsive to review requests as per
|
||||||
[community expectations](REVIEWING.md).
|
[community expectations](REVIEWING.md).
|
||||||
|
@ -218,12 +220,11 @@ enlist help from engineers for reviewing code-heavy contributions to the Docs re
|
||||||
|
|
||||||
### Becoming an approver
|
### Becoming an approver
|
||||||
|
|
||||||
If you want to become an approver, make your goal clear to the current
|
If you want to become an approver, make your goal clear to the current Knative
|
||||||
Knative Docs approvers, either by contacting them in Slack or announcing
|
Docs approvers, either by contacting them in Slack or announcing your intention
|
||||||
your intention to become an approver at a meeting of the Documentation
|
to become an approver at a meeting of the Documentation Working Group.
|
||||||
Working Group.
|
|
||||||
|
|
||||||
Once you feel you meet the criteria, you can ask one of the current
|
Once you feel you meet the criteria, you can ask one of the current approvers to
|
||||||
approvers to nominate you to become an approver. If all existing
|
nominate you to become an approver. If all existing approvers agree that you
|
||||||
approvers agree that you meet the criteria open a PR to add yourself
|
meet the criteria open a PR to add yourself as a docs-approver in the
|
||||||
as a docs-approver in the [OWNERS_ALIASES](../OWNERS_ALIASES) file.
|
[OWNERS_ALIASES](../OWNERS_ALIASES) file.
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
_Important_. Before proceeding, please review the Knative community
|
_Important_. Before proceeding, please review the Knative community
|
||||||
[Code of Conduct](./CODE-OF-CONDUCT.md).
|
[Code of Conduct](./CODE-OF-CONDUCT.md).
|
||||||
|
|
||||||
|
@ -23,14 +22,15 @@ Other Documents
|
||||||
|
|
||||||
- [Code of Conduct](./CODE-OF-CONDUCT.md) - all contributors must abide by the
|
- [Code of Conduct](./CODE-OF-CONDUCT.md) - all contributors must abide by the
|
||||||
code of conduct
|
code of conduct
|
||||||
- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on becoming
|
- [Contributing to Knative](./CONTRIBUTING.md) - guidelines and advice on
|
||||||
a contributor
|
becoming a contributor
|
||||||
- [Working Groups](./WORKING-GROUPS.md) - describes our various working groups
|
- [Working Groups](./WORKING-GROUPS.md) - describes our various working groups
|
||||||
- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how working
|
- [Working Group Processes](./WORKING-GROUP-PROCESSES.md) - describes how
|
||||||
groups operate
|
working groups operate
|
||||||
- [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE.md) - describes our
|
- [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE.md) - describes our
|
||||||
technical oversight committee
|
technical oversight committee
|
||||||
- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering committee
|
- [Steering Committee](./STEERING-COMMITTEE.md) - describes our steering
|
||||||
|
committee
|
||||||
- [Community Roles](./ROLES.md) - describes the roles individuals can assume
|
- [Community Roles](./ROLES.md) - describes the roles individuals can assume
|
||||||
within the Knative community
|
within the Knative community
|
||||||
- [Reviewing and Merging Pull Requests](./REVIEWING.md) - how we manage pull
|
- [Reviewing and Merging Pull Requests](./REVIEWING.md) - how we manage pull
|
||||||
|
@ -39,8 +39,8 @@ Other Documents
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Knative is a Kubernetes-based platform to build, deploy, and manage modern
|
Knative is a Kubernetes-based platform to build, deploy, and manage modern
|
||||||
serverless workloads. See [Knative docs](../docs/README.md) for
|
serverless workloads. See [Knative docs](../docs/README.md) for in-depth
|
||||||
in-depth information about using Knative.
|
information about using Knative.
|
||||||
|
|
||||||
## Knative authors
|
## Knative authors
|
||||||
|
|
||||||
|
@ -56,15 +56,15 @@ tools, platforms, languages, and products. By submitting a tutorial you can
|
||||||
share your experience and help others who are solving similar problems.
|
share your experience and help others who are solving similar problems.
|
||||||
|
|
||||||
Community tutorials are stored in Markdown files under the `community` folder
|
Community tutorials are stored in Markdown files under the `community` folder
|
||||||
[Community Samples](../community/samples/README.md). These documents
|
[Community Samples](../community/samples/README.md). These documents are
|
||||||
are contributed, reviewed, and maintained by the community.
|
contributed, reviewed, and maintained by the community.
|
||||||
|
|
||||||
Submit a Pull Request to the community sample directory under the Knative
|
Submit a Pull Request to the community sample directory under the Knative
|
||||||
component folder that aligns with your document. For example, Knative Serving
|
component folder that aligns with your document. For example, Knative Serving
|
||||||
samples are under the `serving` folder. A reviewer will be assigned to review your
|
samples are under the `serving` folder. A reviewer will be assigned to review
|
||||||
submission. They'll work with you to ensure that your submission is clear, correct,
|
your submission. They'll work with you to ensure that your submission is clear,
|
||||||
and meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if you follow it
|
correct, and meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if
|
||||||
as you write your tutorial.
|
you follow it as you write your tutorial.
|
||||||
|
|
||||||
## Meetings and work groups
|
## Meetings and work groups
|
||||||
|
|
||||||
|
@ -98,7 +98,8 @@ following resources are available for you:
|
||||||
- [Knative Users](https://groups.google.com/forum/#!forum/knative-users)
|
- [Knative Users](https://groups.google.com/forum/#!forum/knative-users)
|
||||||
- [Knative Developers](https://groups.google.com/forum/#!forum/knative-dev)
|
- [Knative Developers](https://groups.google.com/forum/#!forum/knative-dev)
|
||||||
|
|
||||||
For contributors to Knative, we also have [Knative Slack](./SLACK-GUIDELINES.md).
|
For contributors to Knative, we also have
|
||||||
|
[Knative Slack](./SLACK-GUIDELINES.md).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -30,8 +30,8 @@ Please do not ever hesitate to ask a question or submit a PR.
|
||||||
|
|
||||||
Reviewers are often the first points of contact between new members of the
|
Reviewers are often the first points of contact between new members of the
|
||||||
community and are important in shaping the community. We encourage reviewers to
|
community and are important in shaping the community. We encourage reviewers to
|
||||||
read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and
|
read the [code of conduct](./CODE-OF-CONDUCT.md) and to go above and beyond the
|
||||||
beyond the code of conduct to promote a collaborative and respectful community.
|
code of conduct to promote a collaborative and respectful community.
|
||||||
|
|
||||||
## Code reviewers
|
## Code reviewers
|
||||||
|
|
||||||
|
|
|
@ -5,9 +5,9 @@ weight: 55
|
||||||
type: "docs"
|
type: "docs"
|
||||||
---
|
---
|
||||||
|
|
||||||
This document describes the set of roles individuals might have within the Knative
|
This document describes the set of roles individuals might have within the
|
||||||
community, the requirements of each role, and the privileges that each role
|
Knative community, the requirements of each role, and the privileges that each
|
||||||
grants.
|
role grants.
|
||||||
|
|
||||||
- [Role Summary](#role-summary)
|
- [Role Summary](#role-summary)
|
||||||
- [Collaborator](#collaborator)
|
- [Collaborator](#collaborator)
|
||||||
|
@ -120,8 +120,8 @@ with the PR bot.
|
||||||
- Working on some contribution to the project that would benefit from the
|
- Working on some contribution to the project that would benefit from the
|
||||||
ability to have PRs or Issues to be assigned to the contributor.
|
ability to have PRs or Issues to be assigned to the contributor.
|
||||||
|
|
||||||
- Join [knative-users@](https://groups.google.com/forum/#!forum/knative-users)
|
- Join [knative-users@](https://groups.google.com/forum/#!forum/knative-users) ,
|
||||||
, which grants read access to documents in the Team Drive.
|
which grants read access to documents in the Team Drive.
|
||||||
|
|
||||||
## Member
|
## Member
|
||||||
|
|
||||||
|
@ -143,8 +143,8 @@ this is not a requirement.
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
- Has made multiple contributions to the project or community. Contributions might
|
- Has made multiple contributions to the project or community. Contributions
|
||||||
include, but are not limited to:
|
might include, but are not limited to:
|
||||||
|
|
||||||
- Authoring and reviewing PRs on GitHub.
|
- Authoring and reviewing PRs on GitHub.
|
||||||
|
|
||||||
|
@ -195,13 +195,13 @@ approver in an OWNERS file:
|
||||||
- Reviewer of the codebase for at least 3 months.
|
- Reviewer of the codebase for at least 3 months.
|
||||||
|
|
||||||
- Primary reviewer for at least 10 substantial PRs to the codebase.
|
- Primary reviewer for at least 10 substantial PRs to the codebase.
|
||||||
|
|
||||||
- One path for getting the necessary reviews is to add yourself to the
|
- One path for getting the necessary reviews is to add yourself to the
|
||||||
`reviewers` section of the OWNERS file. Note that this does not give
|
`reviewers` section of the OWNERS file. Note that this does not give you any
|
||||||
you any additional privileges. By having yourself listed in this
|
additional privileges. By having yourself listed in this section in OWNERS
|
||||||
section in OWNERS file means that you will get PRs assigned to you
|
file means that you will get PRs assigned to you for code review. Getting
|
||||||
for code review. Getting added to `reviewers` section is at the
|
added to `reviewers` section is at the discretion of an approver after
|
||||||
discretion of an approver after enough evidence of quality
|
enough evidence of quality contributions.
|
||||||
contributions.
|
|
||||||
|
|
||||||
- Reviewed or merged at least 30 PRs to the codebase.
|
- Reviewed or merged at least 30 PRs to the codebase.
|
||||||
|
|
||||||
|
@ -218,18 +218,17 @@ approver in an OWNERS file:
|
||||||
|
|
||||||
- Demonstrate sound technical judgment.
|
- Demonstrate sound technical judgment.
|
||||||
|
|
||||||
|
* Responsible for project quality control via [code reviews](./REVIEWING.md).
|
||||||
- Responsible for project quality control via [code reviews](./REVIEWING.md).
|
|
||||||
|
|
||||||
- Focus on holistic acceptance of contribution such as dependencies with other
|
- Focus on holistic acceptance of contribution such as dependencies with other
|
||||||
features, backward / forward compatibility, API and flag definitions, etc.
|
features, backward / forward compatibility, API and flag definitions, etc.
|
||||||
|
|
||||||
- Expected to be responsive to review requests as per
|
* Expected to be responsive to review requests as per
|
||||||
[community expectations](./REVIEWING.md).
|
[community expectations](./REVIEWING.md).
|
||||||
|
|
||||||
- Mentor members and contributors.
|
* Mentor members and contributors.
|
||||||
|
|
||||||
- Might approve code contributions for acceptance.
|
* Might approve code contributions for acceptance.
|
||||||
|
|
||||||
## Lead
|
## Lead
|
||||||
|
|
||||||
|
|
|
@ -100,8 +100,7 @@ working group:
|
||||||
these meetings between 9:00AM to 2:59PM Pacific Time. Invite the public Google
|
these meetings between 9:00AM to 2:59PM Pacific Time. Invite the public Google
|
||||||
group to the meeting.
|
group to the meeting.
|
||||||
|
|
||||||
- **Register the Working Group**. Go to
|
- **Register the Working Group**. Go to [WORKING-GROUPS.md](./WORKING-GROUPS.md)
|
||||||
[WORKING-GROUPS.md](./WORKING-GROUPS.md)
|
|
||||||
and add your working group name, the names of the leads, the working group
|
and add your working group name, the names of the leads, the working group
|
||||||
charter, and a link to the meeting you created.
|
charter, and a link to the meeting you created.
|
||||||
|
|
||||||
|
@ -189,9 +188,10 @@ Leads from all affected working groups generally work together and come to an
|
||||||
agreeable conclusion.
|
agreeable conclusion.
|
||||||
|
|
||||||
In all cases, remaining blocking issues can be raised to the
|
In all cases, remaining blocking issues can be raised to the
|
||||||
[technical oversight committee](./TECH-OVERSIGHT-COMMITTEE.md) to help resolve the
|
[technical oversight committee](./TECH-OVERSIGHT-COMMITTEE.md) to help resolve
|
||||||
situation. To trigger an escalation, create an issue in the `knative/serving`
|
the situation. To trigger an escalation, create an issue in the
|
||||||
repo and assign it to the **@knative/tech-oversight-committee** team.
|
`knative/serving` repo and assign it to the
|
||||||
|
**@knative/tech-oversight-committee** team.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -12,8 +12,8 @@ each of these groups may operate a little differently depending on their needs
|
||||||
and workflow.
|
and workflow.
|
||||||
|
|
||||||
When the need arises, a new working group can be created. See the
|
When the need arises, a new working group can be created. See the
|
||||||
[working group processes](./WORKING-GROUP-PROCESSES.md) for working group proposal
|
[working group processes](./WORKING-GROUP-PROCESSES.md) for working group
|
||||||
and creation procedures.
|
proposal and creation procedures.
|
||||||
|
|
||||||
The working groups generate design docs which are kept in a
|
The working groups generate design docs which are kept in a
|
||||||
[shared drive](https://drive.google.com/corp/drive/folders/0APnJ_hRs30R2Uk9PVA)
|
[shared drive](https://drive.google.com/corp/drive/folders/0APnJ_hRs30R2Uk9PVA)
|
||||||
|
@ -103,8 +103,7 @@ conventions
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Knative documentation, especially the [Docs](../docs/README.md)
|
Knative documentation, especially the [Docs](../docs/README.md) repo.
|
||||||
repo.
|
|
||||||
|
|
||||||
| Artifact | Link |
|
| Artifact | Link |
|
||||||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
|
|
|
@ -12,7 +12,7 @@ aliases:
|
||||||
|
|
||||||
Learn how to join the community of Knative contributors.
|
Learn how to join the community of Knative contributors.
|
||||||
|
|
||||||
Also see our [Community page](../community) for links to Knative chats, discussions, or Q&A.
|
Also see our [Community page](../community) for links to Knative chats,
|
||||||
|
discussions, or Q&A.
|
||||||
|
|
||||||
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
{{% readfile file="README.md" relative="true" markdown="true" %}}
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# Documentation Releases
|
# Documentation Releases
|
||||||
|
|
||||||
The available versions of the Knative documentation can be found on the
|
The available versions of the Knative documentation can be found on the
|
||||||
[website](https://www.knative.dev).
|
[website](https://www.knative.dev). You can also view the documentation source
|
||||||
You can also view the documentation source files in one of the branches.
|
files in one of the branches.
|
||||||
|
|
||||||
## Documentation website
|
## Documentation website
|
||||||
|
|
||||||
|
@ -10,13 +10,12 @@ Use the Knative Documentation website to learn about the product:
|
||||||
|
|
||||||
- [`https://www.knative.dev`](https://www.knative.dev)
|
- [`https://www.knative.dev`](https://www.knative.dev)
|
||||||
|
|
||||||
|
|
||||||
## `knative/docs` branches
|
## `knative/docs` branches
|
||||||
|
|
||||||
If you want to fix or add content to a past release, you can find the source files
|
If you want to fix or add content to a past release, you can find the source
|
||||||
in the following branches:
|
files in the following branches:
|
||||||
|
|
||||||
* **Released versions**
|
- **Released versions**
|
||||||
|
|
||||||
The following branches include content for released versions of Knative:
|
The following branches include content for released versions of Knative:
|
||||||
|
|
||||||
|
@ -25,7 +24,7 @@ in the following branches:
|
||||||
- [**`release-0.2`**](https://github.com/knative/docs/tree/release-0.2)
|
- [**`release-0.2`**](https://github.com/knative/docs/tree/release-0.2)
|
||||||
- [**`release-0.1`**](https://github.com/knative/docs/tree/release-0.1)
|
- [**`release-0.1`**](https://github.com/knative/docs/tree/release-0.1)
|
||||||
|
|
||||||
* **Development (pre-release) version**
|
- **Development (pre-release) version**
|
||||||
|
|
||||||
The `master` branch includes pre-release content for the next Knative version:
|
The `master` branch includes pre-release content for the next Knative version:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Knative (pronounced kay-nay-tiv) extends
|
Knative (pronounced kay-nay-tiv) extends
|
||||||
[Kubernetes](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/)
|
[Kubernetes](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/)
|
||||||
to provide a set of middleware components that are essential to build modern,
|
to provide a set of middleware components that are essential to build modern,
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A `Build` is a custom resource in Knative that allows you to define a process
|
A `Build` is a custom resource in Knative that allows you to define a process
|
||||||
that runs to completion and can provide status. For example, fetch, build, and
|
that runs to completion and can provide status. For example, fetch, build, and
|
||||||
package your code by using a Knative `Build` that communicates whether the
|
package your code by using a Knative `Build` that communicates whether the
|
||||||
|
@ -12,9 +11,8 @@ action, you can define a Knative `Build` through a single configuration file.
|
||||||
|
|
||||||
Also consider using a Knative `Build` to build the source code of your apps into
|
Also consider using a Knative `Build` to build the source code of your apps into
|
||||||
container images, which you can then run on
|
container images, which you can then run on
|
||||||
[Knative `serving`](../serving/README.md).
|
[Knative `serving`](../serving/README.md). More information about this use case
|
||||||
More information about this use case is demonstrated in
|
is demonstrated in [this sample](../serving/samples/source-to-url-go).
|
||||||
[this sample](../serving/samples/source-to-url-go).
|
|
||||||
|
|
||||||
## Key features of Knative Builds
|
## Key features of Knative Builds
|
||||||
|
|
||||||
|
|
|
@ -35,8 +35,9 @@ Kubernetes cluster, and it must include the Knative Build component:
|
||||||
1. Create a configuration file named `build.yaml` that includes the following
|
1. Create a configuration file named `build.yaml` that includes the following
|
||||||
code.
|
code.
|
||||||
|
|
||||||
This `Build` resource definition includes a single "[step](./builds.md#steps)"
|
This `Build` resource definition includes a single
|
||||||
that performs the task of simply printing "_hello build_":
|
"[step](./builds.md#steps)" that performs the task of simply printing "_hello
|
||||||
|
build_":
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
apiVersion: build.knative.dev/v1alpha1
|
apiVersion: build.knative.dev/v1alpha1
|
||||||
|
|
|
@ -62,9 +62,9 @@ Docker daemon, which would give the build complete access to your entire
|
||||||
cluster. So that's a very bad idea.
|
cluster. So that's a very bad idea.
|
||||||
|
|
||||||
`kaniko` expects to run inside a container, so it's a natural fit for the Build
|
`kaniko` expects to run inside a container, so it's a natural fit for the Build
|
||||||
CRD [builder contract](../build/builder-contract.md). `kaniko` is available as a builder at
|
CRD [builder contract](../build/builder-contract.md). `kaniko` is available as a
|
||||||
`gcr.io/kaniko-project/executor:latest`, and there's a `BuildTemplate` that
|
builder at `gcr.io/kaniko-project/executor:latest`, and there's a
|
||||||
wraps it at
|
`BuildTemplate` that wraps it at
|
||||||
https://github.com/knative/build-templates/blob/master/kaniko/kaniko.yaml. It
|
https://github.com/knative/build-templates/blob/master/kaniko/kaniko.yaml. It
|
||||||
exposes one required parameter, `IMAGE`, which describes the name of the image
|
exposes one required parameter, `IMAGE`, which describes the name of the image
|
||||||
to push to.
|
to push to.
|
||||||
|
@ -81,8 +81,8 @@ abstracting away the container image being used, and instead referring to Go
|
||||||
packages by their [import paths](https://golang.org/doc/code.html#ImportPaths)
|
packages by their [import paths](https://golang.org/doc/code.html#ImportPaths)
|
||||||
(e.g., `github.com/kaniko/serving/cmd/controller`)
|
(e.g., `github.com/kaniko/serving/cmd/controller`)
|
||||||
|
|
||||||
The typical usage is `ko apply --filename config.yaml`, which reads in the config YAML,
|
The typical usage is `ko apply --filename config.yaml`, which reads in the
|
||||||
and looks for Go import paths representing runnable commands (i.e.,
|
config YAML, and looks for Go import paths representing runnable commands (i.e.,
|
||||||
`package main`). When it finds a matching import path, `ko` builds the package
|
`package main`). When it finds a matching import path, `ko` builds the package
|
||||||
using `go build` then pushes a container image containing that binary on top of
|
using `go build` then pushes a container image containing that binary on top of
|
||||||
a base image (by default, `gcr.io/distroless/base`) to
|
a base image (by default, `gcr.io/distroless/base`) to
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Knative Eventing is a system that is designed to address a common need for cloud
|
Knative Eventing is a system that is designed to address a common need for cloud
|
||||||
native development and provides composable primitives to enable late-binding
|
native development and provides composable primitives to enable late-binding
|
||||||
event sources and event consumers.
|
event sources and event consumers.
|
||||||
|
@ -176,7 +175,11 @@ The GitHubSource fires a new event for selected
|
||||||
- `sink`:
|
- `sink`:
|
||||||
[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core)
|
[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#objectreference-v1-core)
|
||||||
A reference to the object that should receive events.
|
A reference to the object that should receive events.
|
||||||
- `githubAPIURL`: `string` Optional field to specify the base URL for API requests. Defaults to the public GitHub API if not specified, but can be set to a domain endpoint to use with GitHub Enterprise, for example, `https://github.mycompany.com/api/v3/`. This base URL should always be specified with a trailing slash.
|
- `githubAPIURL`: `string` Optional field to specify the base URL for API
|
||||||
|
requests. Defaults to the public GitHub API if not specified, but can be set
|
||||||
|
to a domain endpoint to use with GitHub Enterprise, for example,
|
||||||
|
`https://github.mycompany.com/api/v3/`. This base URL should always be
|
||||||
|
specified with a trailing slash.
|
||||||
|
|
||||||
See the [GitHub Source](samples/github-source) example.
|
See the [GitHub Source](samples/github-source) example.
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,11 @@
|
||||||
|
|
||||||
This is an evolving document on how to debug a non-working Knative Eventing
|
This is an evolving document on how to debug a non-working Knative Eventing
|
||||||
setup.
|
setup.
|
||||||
|
|
||||||
## Audience
|
## Audience
|
||||||
|
|
||||||
This document is intended for people that are familiar with the object model of
|
This document is intended for people that are familiar with the object model of
|
||||||
[Knative Eventing](../README.md). You don't need to be an expert,
|
[Knative Eventing](../README.md). You don't need to be an expert, but do need to
|
||||||
but do need to know roughly how things fit together.
|
know roughly how things fit together.
|
||||||
|
|
||||||
## Version
|
## Version
|
||||||
|
|
||||||
|
@ -111,7 +110,10 @@ Verify that the `Pod` is `Ready`:
|
||||||
kubectl --namespace knative-debug get pod -l app=fn -o jsonpath='{.items[*].status.conditions[?(@.type == "Ready")].status}'
|
kubectl --namespace knative-debug get pod -l app=fn -o jsonpath='{.items[*].status.conditions[?(@.type == "Ready")].status}'
|
||||||
```
|
```
|
||||||
|
|
||||||
This should return `True`. If it doesn't, then try to debug the `Deployment` using the [Kubernetes Application Debugging](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application-introspection/) guide.
|
This should return `True`. If it doesn't, then try to debug the `Deployment`
|
||||||
|
using the
|
||||||
|
[Kubernetes Application Debugging](https://kubernetes.io/docs/tasks/debug-application-cluster/debug-application-introspection/)
|
||||||
|
guide.
|
||||||
|
|
||||||
##### `svc`
|
##### `svc`
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Cron Job Source example shows how to configure Cron Job as event source for
|
Cron Job Source example shows how to configure Cron Job as event source for
|
||||||
functions.
|
functions.
|
||||||
|
|
||||||
|
@ -7,8 +6,7 @@ functions.
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
1. Setup [Knative Serving](../../../serving).
|
1. Setup [Knative Serving](../../../serving).
|
||||||
1. Setup
|
1. Setup [Knative Eventing](../../../eventing).
|
||||||
[Knative Eventing](../../../eventing).
|
|
||||||
|
|
||||||
### Create a Knative Service
|
### Create a Knative Service
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This sample shows how to configure the GCP PubSub event source. This event
|
This sample shows how to configure the GCP PubSub event source. This event
|
||||||
source is most useful as a bridge from other GCP services, such as
|
source is most useful as a bridge from other GCP services, such as
|
||||||
[Cloud Storage](https://cloud.google.com/storage/docs/pubsub-notifications),
|
[Cloud Storage](https://cloud.google.com/storage/docs/pubsub-notifications),
|
||||||
|
@ -17,9 +16,8 @@ source is most useful as a bridge from other GCP services, such as
|
||||||
|
|
||||||
1. Setup [Knative Serving](../../../install)
|
1. Setup [Knative Serving](../../../install)
|
||||||
|
|
||||||
1. Setup
|
1. Setup [Knative Eventing](../../../eventing). In addition, install the GCP
|
||||||
[Knative Eventing](../../../eventing). In
|
PubSub event source from `release-gcppubsub.yaml`:
|
||||||
addition, install the GCP PubSub event source from `release-gcppubsub.yaml`:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl apply --filename https://github.com/knative/eventing-sources/releases/download/v0.3.0/release-gcppubsub.yaml
|
kubectl apply --filename https://github.com/knative/eventing-sources/releases/download/v0.3.0/release-gcppubsub.yaml
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This sample shows how to bind a running service to an
|
This sample shows how to bind a running service to an
|
||||||
[IoT core](https://cloud.google.com/iot-core/) using
|
[IoT core](https://cloud.google.com/iot-core/) using
|
||||||
[GCP PubSub](https://cloud.google.com/pubsub/) as the event source. With minor
|
[GCP PubSub](https://cloud.google.com/pubsub/) as the event source. With minor
|
||||||
|
@ -66,8 +65,7 @@ export IOTCORE_TOPIC_DEVICE="iot-demo-device-pubsub-topic"
|
||||||
gcloud pubsub topics create $IOTCORE_TOPIC_DEVICE
|
gcloud pubsub topics create $IOTCORE_TOPIC_DEVICE
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Setup
|
1. Setup [Knative Eventing](../../../eventing).
|
||||||
[Knative Eventing](../../../eventing).
|
|
||||||
|
|
||||||
1. Install the
|
1. Install the
|
||||||
[in-memory `ClusterChannelProvisioner`](https://github.com/knative/eventing/tree/master/config/provisioners/in-memory-channel).
|
[in-memory `ClusterChannelProvisioner`](https://github.com/knative/eventing/tree/master/config/provisioners/in-memory-channel).
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Kubernetes Event Source example shows how to wire kubernetes cluster events for
|
Kubernetes Event Source example shows how to wire kubernetes cluster events for
|
||||||
consumption by a function that has been implemented as a Knative Service.
|
consumption by a function that has been implemented as a Knative Service.
|
||||||
|
|
||||||
|
@ -7,8 +6,7 @@ consumption by a function that has been implemented as a Knative Service.
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
1. Setup [Knative Serving](../../../serving).
|
1. Setup [Knative Serving](../../../serving).
|
||||||
1. Setup
|
1. Setup [Knative Eventing](../../../eventing).
|
||||||
[Knative Eventing](../../../eventing).
|
|
||||||
|
|
||||||
### Channel
|
### Channel
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This tutorial walks you through creating an event source for Knative Eventing
|
This tutorial walks you through creating an event source for Knative Eventing
|
||||||
"the hard way", without using helper objects like ContainerSource.
|
"the hard way", without using helper objects like ContainerSource.
|
||||||
|
|
||||||
|
@ -38,11 +37,11 @@ You'll need these tools installed:
|
||||||
|
|
||||||
Kubebuilder not your thing? Prefer the easy way? Check out these alternatives.
|
Kubebuilder not your thing? Prefer the easy way? Check out these alternatives.
|
||||||
|
|
||||||
- [ContainerSource](../../../eventing/sources/README.md#meta-sources)
|
- [ContainerSource](../../../eventing/sources/README.md#meta-sources) is an easy
|
||||||
is an easy way to turn any dispatcher container into an Event Source.
|
way to turn any dispatcher container into an Event Source.
|
||||||
- [Auto ContainerSource](../../../eventing/sources/README.md#meta-sources)
|
- [Auto ContainerSource](../../../eventing/sources/README.md#meta-sources) is an
|
||||||
is an even easier way to turn any dispatcher container into an Event Source
|
even easier way to turn any dispatcher container into an Event Source without
|
||||||
without writing any controller code. It requires Metacontroller.
|
writing any controller code. It requires Metacontroller.
|
||||||
- [Metacontroller](https://metacontroller.app) can be used to write controllers
|
- [Metacontroller](https://metacontroller.app) can be used to write controllers
|
||||||
as webhooks in any language.
|
as webhooks in any language.
|
||||||
- The [Cloud Scheduler source](https://github.com/vaikas-google/csr) uses the
|
- The [Cloud Scheduler source](https://github.com/vaikas-google/csr) uses the
|
||||||
|
|
|
@ -49,16 +49,15 @@ These are not directly usable, but make writing a Source much easier.
|
||||||
|
|
||||||
These are containers intended to be used with `ContainerSource`.
|
These are containers intended to be used with `ContainerSource`.
|
||||||
|
|
||||||
Name | Status | Support | Description
|
| Name | Status | Support | Description |
|
||||||
--- | --- | --- | ---
|
| ------------------------------------------------------------------------------------------------- | ------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||||
[AWS CodeCommit](https://github.com/triggermesh/knative-lambda-sources/tree/master/awscodecommit) | Active Development | TriggerMesh | Registers for events of the specified types on the specified AWS CodeCommit repository. Brings those events into Knative.
|
| [AWS CodeCommit](https://github.com/triggermesh/knative-lambda-sources/tree/master/awscodecommit) | Active Development | TriggerMesh | Registers for events of the specified types on the specified AWS CodeCommit repository. Brings those events into Knative. |
|
||||||
[AWS Cognito](https://github.com/triggermesh/knative-lambda-sources/tree/master/awscognito) | Active Development | TriggerMesh | Registers for AWS Cognito events. Brings those events into Knative.
|
| [AWS Cognito](https://github.com/triggermesh/knative-lambda-sources/tree/master/awscognito) | Active Development | TriggerMesh | Registers for AWS Cognito events. Brings those events into Knative. |
|
||||||
[AWS DynamoDB](https://github.com/triggermesh/knative-lambda-sources/tree/master/awsdynamodb) | Active Development | TriggerMesh | Registers for events of on the specified AWS DynamoDB table. Brings those events into Knative.
|
| [AWS DynamoDB](https://github.com/triggermesh/knative-lambda-sources/tree/master/awsdynamodb) | Active Development | TriggerMesh | Registers for events of on the specified AWS DynamoDB table. Brings those events into Knative. |
|
||||||
[AWS Kinesis](https://github.com/triggermesh/knative-lambda-sources/tree/master/awskinesis) | Active Development | TriggerMesh | Registers for events on the specified AWS Kinesis stream. Brings those events into Knative.
|
| [AWS Kinesis](https://github.com/triggermesh/knative-lambda-sources/tree/master/awskinesis) | Active Development | TriggerMesh | Registers for events on the specified AWS Kinesis stream. Brings those events into Knative. |
|
||||||
[AWS SNS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssns) | Active Development | TriggerMesh | Registers for events of the specified AWS SNS endpoint. Brings those events into Knative.
|
| [AWS SNS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssns) | Active Development | TriggerMesh | Registers for events of the specified AWS SNS endpoint. Brings those events into Knative. |
|
||||||
[AWS SQS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssqs) | Active Development | TriggerMesh | Registers for events of the specified AWS SQS queue. Brings those events into Knative.
|
| [AWS SQS](https://github.com/triggermesh/knative-lambda-sources/tree/master/awssqs) | Active Development | TriggerMesh | Registers for events of the specified AWS SQS queue. Brings those events into Knative. |
|
||||||
[Heartbeat](https://github.com/knative/eventing-sources/tree/master/cmd/heartbeats) | Proof of Concept | None | Uses an in-memory timer to produce events at the specified interval.
|
| [Heartbeat](https://github.com/knative/eventing-sources/tree/master/cmd/heartbeats) | Proof of Concept | None | Uses an in-memory timer to produce events at the specified interval. |
|
||||||
[Heartbeat](https://github.com/Harwayne/auto-container-source/tree/master/heartbeat-source) | Proof of Concept | None | Uses an in-memory timer to produce events as the specified interval. Uses AutoContainerSource for underlying infrastructure.
|
| [Heartbeat](https://github.com/Harwayne/auto-container-source/tree/master/heartbeat-source) | Proof of Concept | None | Uses an in-memory timer to produce events as the specified interval. Uses AutoContainerSource for underlying infrastructure. |
|
||||||
[K8s](https://github.com/Harwayne/auto-container-source/tree/master/k8s-event-source) | Proof of Concept | None | Brings Kubernetes cluster events into Knative. Uses AutoContainerSource for underlying infrastructure.
|
| [K8s](https://github.com/Harwayne/auto-container-source/tree/master/k8s-event-source) | Proof of Concept | None | Brings Kubernetes cluster events into Knative. Uses AutoContainerSource for underlying infrastructure. |
|
||||||
[WebSocket](https://github.com/knative/eventing-sources/tree/master/cmd/websocketsource) | Active Development | None | Opens a WebSocket to the specified source and packages each received message as a Knative event.
|
| [WebSocket](https://github.com/knative/eventing-sources/tree/master/cmd/websocketsource) | Active Development | None | Opens a WebSocket to the specified source and packages each received message as a Knative event. |
|
||||||
|
|
||||||
|
|
|
@ -156,11 +156,11 @@ Each Knative component must be installed individually. You can decide which
|
||||||
components and observability plugins to install based on what you plan to do
|
components and observability plugins to install based on what you plan to do
|
||||||
with Knative.
|
with Knative.
|
||||||
|
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> commands. They will likely succeed on the second attempt. For background info
|
||||||
track the upcoming solution to this problem, see issues
|
> and to track the upcoming solution to this problem, see issues
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
### Choosing Knative installation files
|
### Choosing Knative installation files
|
||||||
|
|
||||||
|
@ -199,7 +199,7 @@ files from the Knative repositories:
|
||||||
- [Eventing Sources][5]
|
- [Eventing Sources][5]
|
||||||
|
|
||||||
| Knative Install Filename | Notes | Dependencies |
|
| Knative Install Filename | Notes | Dependencies |
|
||||||
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
|
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- |
|
||||||
| **knative/serving** | | |
|
| **knative/serving** | | |
|
||||||
| [`serving.yaml`][1.1]† | Installs the Serving component. | Cluster roles enabled, if interacting with Build |
|
| [`serving.yaml`][1.1]† | Installs the Serving component. | Cluster roles enabled, if interacting with Build |
|
||||||
| [`monitoring.yaml`][1.2]† | Installs the [ELK stack][2], [Prometheus][2.1], [Grafana][2.2], and [Zipkin][2.3]**\*** | Serving component |
|
| [`monitoring.yaml`][1.2]† | Installs the [ELK stack][2], [Prometheus][2.1], [Grafana][2.2], and [Zipkin][2.3]**\*** | Serving component |
|
||||||
|
@ -228,6 +228,7 @@ for details about installing the various supported observability plug-ins.
|
||||||
† These are the recommended standard install files suitable for most use cases.
|
† These are the recommended standard install files suitable for most use cases.
|
||||||
|
|
||||||
<!-- USE ONLY FULLY QUALIFIED URLS -->
|
<!-- USE ONLY FULLY QUALIFIED URLS -->
|
||||||
|
|
||||||
[1]: https://github.com/knative/serving/releases/tag/v0.4.0
|
[1]: https://github.com/knative/serving/releases/tag/v0.4.0
|
||||||
[1.1]: https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml
|
[1.1]: https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml
|
||||||
[1.2]:
|
[1.2]:
|
||||||
|
@ -268,7 +269,8 @@ for details about installing the various supported observability plug-ins.
|
||||||
[6.2]:
|
[6.2]:
|
||||||
https://github.com/knative/eventing-sources/blob/master/samples/cronjob-source/README.md
|
https://github.com/knative/eventing-sources/blob/master/samples/cronjob-source/README.md
|
||||||
[6.3]: https://cloud.google.com/pubsub/
|
[6.3]: https://cloud.google.com/pubsub/
|
||||||
[7]: https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
[7]:
|
||||||
|
https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
|
|
||||||
### Installing Knative
|
### Installing Knative
|
||||||
|
|
||||||
|
@ -279,19 +281,22 @@ commands below.
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. To install Knative components or plugins, specify the filenames in the
|
1. To install Knative components or plugins, specify the filenames in the
|
||||||
`kubectl apply` command:
|
`kubectl apply` command:
|
||||||
|
@ -324,14 +329,16 @@ commands below.
|
||||||
|
|
||||||
**Example install commands:**
|
**Example install commands:**
|
||||||
|
|
||||||
* To install the Knative Serving component with the set of observability plug-ins:
|
- To install the Knative Serving component with the set of observability
|
||||||
|
plug-ins:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
* To install all three Knative components and the set of Eventing sources without an observability plugin:
|
* To install all three Knative components and the set of Eventing sources
|
||||||
|
without an observability plugin:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
||||||
|
@ -393,4 +400,3 @@ Except as otherwise noted, the content of this page is licensed under the
|
||||||
[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/),
|
[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/),
|
||||||
and code samples are licensed under the
|
and code samples are licensed under the
|
||||||
[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
|
[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
|
||||||
|
|
||||||
|
|
|
@ -177,21 +177,25 @@ your Knative installation, see
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
||||||
--filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
--filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
||||||
|
@ -200,14 +204,16 @@ your Knative installation, see
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
track the upcoming solution to this problem, see issues
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
|
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
|
|
|
@ -64,8 +64,8 @@ rerun the command to see the current status.
|
||||||
Next, install [Knative Serving](https://github.com/knative/serving).
|
Next, install [Knative Serving](https://github.com/knative/serving).
|
||||||
|
|
||||||
Because you have limited resources available, use the
|
Because you have limited resources available, use the
|
||||||
`https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml`
|
`https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml` file,
|
||||||
file, which installs only Knative Serving:
|
which installs only Knative Serving:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -L https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
curl -L https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
||||||
|
|
|
@ -178,19 +178,22 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
```bash
|
```bash
|
||||||
|
@ -201,14 +204,15 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
track the upcoming solution to this problem, see issues
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -113,21 +113,25 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
kubectl apply --filename https://github.com/knative/serving/releases/download/v0.4.0/serving.yaml \
|
||||||
--filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
--filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
||||||
|
@ -136,14 +140,17 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
track the upcoming solution to this problem, see issues
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
|
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -99,8 +99,8 @@ curl -H "Host: helloworld-go.myproject.example.com" $GATEWAY_URL
|
||||||
```
|
```
|
||||||
|
|
||||||
The full instructions for the
|
The full instructions for the
|
||||||
[Go Hello-World Sample](../serving/samples/hello-world/helloworld-go) with this substitution
|
[Go Hello-World Sample](../serving/samples/hello-world/helloworld-go) with this
|
||||||
are published bellow:
|
substitution are published bellow:
|
||||||
|
|
||||||
### Deploy the Hello-World Go App:
|
### Deploy the Hello-World Go App:
|
||||||
|
|
||||||
|
@ -258,8 +258,8 @@ Hello Go Sample v1!
|
||||||
|
|
||||||
> Note: Add `-v` option to get more detail if the `curl` command failed.
|
> Note: Add `-v` option to get more detail if the `curl` command failed.
|
||||||
|
|
||||||
Removing the sample app deployment
|
Removing the sample app deployment To remove the sample app from your cluster,
|
||||||
To remove the sample app from your cluster, delete the service record:
|
delete the service record:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl delete --filename service.yaml
|
kubectl delete --filename service.yaml
|
||||||
|
|
|
@ -135,19 +135,22 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the following commands to install Knative:
|
1. Run the following commands to install Knative:
|
||||||
|
|
||||||
|
@ -186,14 +189,16 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
| sed 's/LoadBalancer/NodePort/' \
|
| sed 's/LoadBalancer/NodePort/' \
|
||||||
| kubectl apply --filename -
|
| kubectl apply --filename -
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
track the upcoming solution to this problem, see issues
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
|
|
||||||
See
|
See
|
||||||
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
|
[Installing logging, metrics, and traces](../serving/installing-logging-metrics-traces.md)
|
||||||
|
|
|
@ -174,19 +174,22 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
```bash
|
```bash
|
||||||
|
@ -197,14 +200,15 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
track the upcoming solution to this problem, see issues
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -98,23 +98,24 @@ component, omitting the other Knative components as well as the observability
|
||||||
and monitoring plugins.
|
and monitoring plugins.
|
||||||
|
|
||||||
If you are upgrading from Knative 0.3.x: Update your domain and static IP
|
If you are upgrading from Knative 0.3.x: Update your domain and static IP
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead of
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
`knative-ingressgateway`. Then run the following to clean up leftover resources:
|
||||||
resources:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also need
|
||||||
you will also need to delete the following resource before upgrading:
|
to delete the following resource before upgrading:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not prevent
|
||||||
not be completed until the upgrade process finishes.
|
modifications to Eventing Source resources, those changes will not be completed
|
||||||
|
until the upgrade process finishes.
|
||||||
|
|
||||||
Enter the following command:
|
Enter the following command:
|
||||||
|
|
||||||
|
|
|
@ -7,9 +7,9 @@ type: "docs"
|
||||||
|
|
||||||
This guide walks you through the installation of the latest version of
|
This guide walks you through the installation of the latest version of
|
||||||
[Knative Serving](https://github.com/knative/serving) on an
|
[Knative Serving](https://github.com/knative/serving) on an
|
||||||
[OpenShift](https://github.com/openshift/origin) Minishift server using pre-built images and
|
[OpenShift](https://github.com/openshift/origin) Minishift server using
|
||||||
demonstrates creating and deploying an image of a sample "hello world" app onto
|
pre-built images and demonstrates creating and deploying an image of a sample
|
||||||
the newly created Knative cluster.
|
"hello world" app onto the newly created Knative cluster.
|
||||||
|
|
||||||
You can find [guides for other platforms here](./README.md).
|
You can find [guides for other platforms here](./README.md).
|
||||||
|
|
||||||
|
@ -154,8 +154,8 @@ until oc login -u admin -p admin; do sleep 5; done;
|
||||||
### Installing Istio
|
### Installing Istio
|
||||||
|
|
||||||
Knative depends on Istio. The
|
Knative depends on Istio. The
|
||||||
[istio-openshift-policies.sh](./scripts/istio-openshift-policies.sh) does run the
|
[istio-openshift-policies.sh](./scripts/istio-openshift-policies.sh) does run
|
||||||
required commands to configure necessary
|
the required commands to configure necessary
|
||||||
[privileges](https://istio.io/docs/setup/kubernetes/platform-setup/openshift/)
|
[privileges](https://istio.io/docs/setup/kubernetes/platform-setup/openshift/)
|
||||||
to the service accounts used by Istio.
|
to the service accounts used by Istio.
|
||||||
|
|
||||||
|
@ -190,9 +190,9 @@ curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scrip
|
||||||
The following section details on deploying
|
The following section details on deploying
|
||||||
[Knative Serving](https://github.com/knative/serving) to OpenShift.
|
[Knative Serving](https://github.com/knative/serving) to OpenShift.
|
||||||
|
|
||||||
The [knative-openshift-policies.sh](./scripts/knative-openshift-policies.sh) runs
|
The [knative-openshift-policies.sh](./scripts/knative-openshift-policies.sh)
|
||||||
the required commands to configure necessary privileges to the service accounts
|
runs the required commands to configure necessary privileges to the service
|
||||||
used by Knative.
|
accounts used by Knative.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scripts/knative-openshift-policies.sh | bash
|
curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scripts/knative-openshift-policies.sh | bash
|
||||||
|
@ -209,19 +209,22 @@ curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scrip
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
oc delete svc knative-ingressgateway -n istio-system
|
oc delete svc knative-ingressgateway -n istio-system
|
||||||
oc delete deploy knative-ingressgateway -n istio-system
|
oc delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
oc delete statefulset/controller-manager -n knative-sources
|
oc delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Install Knative serving:
|
1. Install Knative serving:
|
||||||
|
|
||||||
|
@ -230,8 +233,10 @@ curl -s https://raw.githubusercontent.com/knative/docs/master/docs/install/scrip
|
||||||
oc apply --filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
oc apply --filename https://github.com/knative/build/releases/download/v0.4.0/build.yaml \
|
||||||
oc apply --filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
oc apply --filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
|
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running` or `Completed`:
|
`Running` or `Completed`:
|
||||||
|
|
|
@ -54,7 +54,8 @@ Once the script completes, you'll be ready to test out Knative!
|
||||||
|
|
||||||
## Creating a new OpenShift cluster
|
## Creating a new OpenShift cluster
|
||||||
|
|
||||||
Here are the manual steps which the above script automates for you in case you prefer doing this yourself:
|
Here are the manual steps which the above script automates for you in case you
|
||||||
|
prefer doing this yourself:
|
||||||
|
|
||||||
Create a new OpenShift cluster on your local machine using `oc cluster up`:
|
Create a new OpenShift cluster on your local machine using `oc cluster up`:
|
||||||
|
|
||||||
|
|
|
@ -87,19 +87,22 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
address to be associated with the LoadBalancer `istio-ingressgateway` instead
|
||||||
of `knative-ingressgateway`. Then run the following to clean up leftover
|
of `knative-ingressgateway`. Then run the following to clean up leftover
|
||||||
resources:
|
resources:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete svc knative-ingressgateway -n istio-system
|
kubectl delete svc knative-ingressgateway -n istio-system
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
```bash
|
```bash
|
||||||
|
@ -110,14 +113,15 @@ see [Performing a Custom Knative Installation](./Knative-custom-install.md).
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
track the upcoming solution to this problem, see issues
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -41,6 +41,7 @@ Containers.
|
||||||
```bash
|
```bash
|
||||||
kubectl label namespace default istio-injection=enabled
|
kubectl label namespace default istio-injection=enabled
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Monitor the Istio components until all of the components show a `STATUS` of
|
1. Monitor the Istio components until all of the components show a `STATUS` of
|
||||||
`Running` or `Completed`:
|
`Running` or `Completed`:
|
||||||
|
|
||||||
|
@ -71,14 +72,16 @@ your Knative installation, see
|
||||||
kubectl delete deploy knative-ingressgateway -n istio-system
|
kubectl delete deploy knative-ingressgateway -n istio-system
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have the Knative Eventing Sources component installed,
|
If you have the Knative Eventing Sources component installed, you will also
|
||||||
you will also need to delete the following resource before upgrading:
|
need to delete the following resource before upgrading:
|
||||||
|
|
||||||
```
|
```
|
||||||
kubectl delete statefulset/controller-manager -n knative-sources
|
kubectl delete statefulset/controller-manager -n knative-sources
|
||||||
```
|
```
|
||||||
While the deletion of this resource during the upgrade process will
|
|
||||||
not prevent modifications to Eventing Source resources, those changes will
|
While the deletion of this resource during the upgrade process will not
|
||||||
not be completed until the upgrade process finishes.
|
prevent modifications to Eventing Source resources, those changes will not be
|
||||||
|
completed until the upgrade process finishes.
|
||||||
|
|
||||||
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
1. Run the `kubectl apply` command to install Knative and its dependencies:
|
||||||
|
|
||||||
|
@ -90,14 +93,16 @@ your Knative installation, see
|
||||||
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
--filename https://github.com/knative/serving/releases/download/v0.4.0/monitoring.yaml \
|
||||||
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
--filename https://raw.githubusercontent.com/knative/serving/v0.4.0/third_party/config/build/clusterrole.yaml
|
||||||
```
|
```
|
||||||
> **Note**: If your install fails on the first attempt, try rerunning the commands.
|
|
||||||
They will likely succeed on the second attempt. For background info and to
|
> **Note**: If your install fails on the first attempt, try rerunning the
|
||||||
track the upcoming solution to this problem, see issues
|
> commands. They will likely succeed on the second attempt. For background
|
||||||
[#968](https://github.com/knative/docs/issues/968) and
|
> info and to track the upcoming solution to this problem, see issues
|
||||||
[#1036](https://github.com/knative/docs/issues/1036).
|
> [#968](https://github.com/knative/docs/issues/968) and
|
||||||
|
> [#1036](https://github.com/knative/docs/issues/1036).
|
||||||
|
|
||||||
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
> **Note**: For the v0.4.0 release and newer, the `clusterrole.yaml` file is
|
||||||
> required to enable the Build and Serving components to interact with each other.
|
> required to enable the Build and Serving components to interact with each
|
||||||
|
> other.
|
||||||
|
|
||||||
1. Monitor the Knative components until all of the components show a `STATUS` of
|
1. Monitor the Knative components until all of the components show a `STATUS` of
|
||||||
`Running`:
|
`Running`:
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Follow this guide to install Knative components on a platform of your choice.
|
Follow this guide to install Knative components on a platform of your choice.
|
||||||
|
|
||||||
## Choosing a Kubernetes cluster
|
## Choosing a Kubernetes cluster
|
||||||
|
|
|
@ -20,9 +20,9 @@ You need:
|
||||||
## Sample application
|
## Sample application
|
||||||
|
|
||||||
This guide uses the
|
This guide uses the
|
||||||
[Hello World sample app in Go](../serving/samples/hello-world/helloworld-go) to demonstrate
|
[Hello World sample app in Go](../serving/samples/hello-world/helloworld-go) to
|
||||||
the basic workflow for deploying an app, but these steps can be adapted for your
|
demonstrate the basic workflow for deploying an app, but these steps can be
|
||||||
own application if you have an image of it available on
|
adapted for your own application if you have an image of it available on
|
||||||
[Docker Hub](https://docs.docker.com/docker-hub/repos/),
|
[Docker Hub](https://docs.docker.com/docker-hub/repos/),
|
||||||
[Google Container Registry](https://cloud.google.com/container-registry/docs/pushing-and-pulling),
|
[Google Container Registry](https://cloud.google.com/container-registry/docs/pushing-and-pulling),
|
||||||
or another container image registry.
|
or another container image registry.
|
||||||
|
|
|
@ -14,7 +14,6 @@ The API source files are located at:
|
||||||
- [Eventing API](./eventing/eventing.md)
|
- [Eventing API](./eventing/eventing.md)
|
||||||
- [Event Sources API](./eventing/eventing-sources.md)
|
- [Event Sources API](./eventing/eventing-sources.md)
|
||||||
|
|
||||||
|
|
||||||
## Updating API Reference docs (for Knative maintainers)
|
## Updating API Reference docs (for Knative maintainers)
|
||||||
|
|
||||||
The Knative API reference documentation is manually generated using the
|
The Knative API reference documentation is manually generated using the
|
||||||
|
@ -31,19 +30,19 @@ reference page.
|
||||||
You must meet the following requirements to run the `gen-api-reference-docs.sh`
|
You must meet the following requirements to run the `gen-api-reference-docs.sh`
|
||||||
tool:
|
tool:
|
||||||
|
|
||||||
* You need the following software installed:
|
- You need the following software installed:
|
||||||
* [`git`](https://git-scm.com/download/)
|
- [`git`](https://git-scm.com/download/)
|
||||||
* [`go` version 1.11+](https://golang.org/dl/)
|
- [`go` version 1.11+](https://golang.org/dl/)
|
||||||
* Clone [knative/docs](https://github.com/knative/docs)
|
- Clone [knative/docs](https://github.com/knative/docs) locally. For example:
|
||||||
locally. For example: `git clone git@github.com:knative/docs.git`
|
`git clone git@github.com:knative/docs.git`
|
||||||
|
|
||||||
### Generating the API
|
### Generating the API
|
||||||
|
|
||||||
To generate a version of the API:
|
To generate a version of the API:
|
||||||
|
|
||||||
1. Ensure that your `GOPATH` is empty. The `gen-api-reference-docs.sh`
|
1. Ensure that your `GOPATH` is empty. The `gen-api-reference-docs.sh` script
|
||||||
script will result in the `GOPATH should not be set` error if your `GOPATH`
|
will result in the `GOPATH should not be set` error if your `GOPATH` is
|
||||||
is configured. You view the value by running the following command:
|
configured. You view the value by running the following command:
|
||||||
|
|
||||||
```
|
```
|
||||||
echo $GOPATH
|
echo $GOPATH
|
||||||
|
@ -56,17 +55,17 @@ To generate a version of the API:
|
||||||
export GOPATH=""
|
export GOPATH=""
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Locate the commits or tags that correspond to the version of the API
|
1. Locate the commits or tags that correspond to the version of the API that you
|
||||||
that you want to generate:
|
want to generate:
|
||||||
|
|
||||||
* [Build](https://github.com/knative/build/releases/)
|
- [Build](https://github.com/knative/build/releases/)
|
||||||
* [Eventing](https://github.com/knative/eventing/releases/)
|
- [Eventing](https://github.com/knative/eventing/releases/)
|
||||||
* [Eventing Sources](https://github.com/knative/eventing-sources/releases/)
|
- [Eventing Sources](https://github.com/knative/eventing-sources/releases/)
|
||||||
* [Serving](https://github.com/knative/serving/releases/)
|
- [Serving](https://github.com/knative/serving/releases/)
|
||||||
|
|
||||||
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory,
|
1. To run the `gen-api-reference-docs.sh` command from the `hack` directory, you
|
||||||
you specify the commits or tags for each of the corresponding Knative
|
specify the commits or tags for each of the corresponding Knative component
|
||||||
component variables (`KNATIVE_[component_name]_COMMIT`):
|
variables (`KNATIVE_[component_name]_COMMIT`):
|
||||||
|
|
||||||
```
|
```
|
||||||
KNATIVE_BUILD_COMMIT=[commit_or_tag] \
|
KNATIVE_BUILD_COMMIT=[commit_or_tag] \
|
||||||
|
@ -77,22 +76,22 @@ To generate a version of the API:
|
||||||
```
|
```
|
||||||
|
|
||||||
where `[commit_or_tag]` is the commit or tag in the specific repo that
|
where `[commit_or_tag]` is the commit or tag in the specific repo that
|
||||||
represents the version of the API that you want to generate. Also see
|
represents the version of the API that you want to generate. Also see the
|
||||||
the [example](#example) below.
|
[example](#example) below.
|
||||||
|
|
||||||
**Result**
|
**Result**
|
||||||
|
|
||||||
The `gen-api-reference-docs.sh` tool generates the API in a `tmp` folder.
|
The `gen-api-reference-docs.sh` tool generates the API in a `tmp` folder.
|
||||||
After a successful build, the tool automatically opens that folder
|
After a successful build, the tool automatically opens that folder in the
|
||||||
in the `tmp` directory.
|
`tmp` directory.
|
||||||
|
|
||||||
1. Copy the generated API files into the `docs/reference` directory of your
|
1. Copy the generated API files into the `docs/reference` directory of your
|
||||||
knative/docs clone.
|
knative/docs clone.
|
||||||
|
|
||||||
You can now perform the necessary steps to open a PR, complete a review, and
|
You can now perform the necessary steps to open a PR, complete a review, and
|
||||||
merge the new API files into the appropriate branch of the `knative/docs` repo.
|
merge the new API files into the appropriate branch of the `knative/docs` repo.
|
||||||
See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for
|
See the [contributor flow](../../contributing/DOCS-CONTRIBUTING.md) for details
|
||||||
details about requesting changes in the `knative/docs` repo.
|
about requesting changes in the `knative/docs` repo.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
Knative Serving builds on Kubernetes and Istio to support deploying and serving
|
Knative Serving builds on Kubernetes and Istio to support deploying and serving
|
||||||
of serverless applications and functions. Serving is easy to get started with
|
of serverless applications and functions. Serving is easy to get started with
|
||||||
and scales to support advanced scenarios.
|
and scales to support advanced scenarios.
|
||||||
|
@ -40,9 +39,9 @@ serverless workload behaves on the cluster:
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To get started with Serving, check out one of the [hello world](./samples/) sample
|
To get started with Serving, check out one of the [hello world](./samples/)
|
||||||
projects. These projects use the `Service` resource, which manages all of the
|
sample projects. These projects use the `Service` resource, which manages all of
|
||||||
details for you.
|
the details for you.
|
||||||
|
|
||||||
With the `Service` resource, a deployed service will automatically have a
|
With the `Service` resource, a deployed service will automatically have a
|
||||||
matching route and configuration created. Each time the `Service` is updated, a
|
matching route and configuration created. Each time the `Service` is updated, a
|
||||||
|
@ -80,6 +79,7 @@ in the Knative Serving repository.
|
||||||
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md)
|
- [Assigning a static IP address for Knative on Google Kubernetes Engine](./gke-assigning-static-ip-address.md)
|
||||||
|
|
||||||
## Private Container Registry
|
## Private Container Registry
|
||||||
|
|
||||||
- [Deploying to Knative using a Private Container Registry](./deploying-with-private-registry.md)
|
- [Deploying to Knative using a Private Container Registry](./deploying-with-private-registry.md)
|
||||||
|
|
||||||
## Known Issues
|
## Known Issues
|
||||||
|
|
|
@ -194,8 +194,9 @@ kubectl get build $(kubectl get revision <revision-name> --output jsonpath="{.sp
|
||||||
If there is any failure, the `conditions` in `status` provide the reason. To
|
If there is any failure, the `conditions` in `status` provide the reason. To
|
||||||
access build logs, first execute `kubectl proxy` and then open
|
access build logs, first execute `kubectl proxy` and then open
|
||||||
[Kibana UI](http://localhost:8001/api/v1/namespaces/knative-monitoring/services/kibana-logging/proxy/app/kibana).
|
[Kibana UI](http://localhost:8001/api/v1/namespaces/knative-monitoring/services/kibana-logging/proxy/app/kibana).
|
||||||
Use any of the following filters within Kibana UI to see build logs. For more information about the Knative
|
Use any of the following filters within Kibana UI to see build logs. For more
|
||||||
observability features, see [Installing logging, metrics, and traces](./Installing-logging-metrics-traces.md).
|
information about the Knative observability features, see
|
||||||
|
[Installing logging, metrics, and traces](./Installing-logging-metrics-traces.md).
|
||||||
|
|
||||||
- All build logs: `_exists_:"kubernetes.labels.build-name"`
|
- All build logs: `_exists_:"kubernetes.labels.build-name"`
|
||||||
- Build logs for a specific build: `kubernetes.labels.build-name:"<BUILD NAME>"`
|
- Build logs for a specific build: `kubernetes.labels.build-name:"<BUILD NAME>"`
|
||||||
|
|
|
@ -5,7 +5,12 @@ weight: 10
|
||||||
type: "docs"
|
type: "docs"
|
||||||
---
|
---
|
||||||
|
|
||||||
This guide walks you through deploying an application to Knative from source code in a git repository using a private container registry for the container image. The source code should contain a dockerfile. For this guide, we'll use this [helloworld app](./samples/hello-world/helloworld-go), but you could use your own.
|
This guide walks you through deploying an application to Knative from source
|
||||||
|
code in a git repository using a private container registry for the container
|
||||||
|
image. The source code should contain a dockerfile. For this guide, we'll use
|
||||||
|
this [helloworld app](./samples/hello-world/helloworld-go), but you could use
|
||||||
|
your own.
|
||||||
|
|
||||||
> > > > > > > fe15327... explicit template types (#1061)
|
> > > > > > > fe15327... explicit template types (#1061)
|
||||||
|
|
||||||
This guide walks you through deploying an application to Knative from source
|
This guide walks you through deploying an application to Knative from source
|
||||||
|
@ -15,9 +20,14 @@ this [helloworld app](./samples/hello-world/helloworld-go), but you could use
|
||||||
your own.
|
your own.
|
||||||
|
|
||||||
## Set up a private container registry and obtain credentials
|
## Set up a private container registry and obtain credentials
|
||||||
If you do not want your container image to be publicly available, you may want to use a private container registry. In this example, we'll use IBM Container Registry, but most of these concepts will be similar for other clouds.
|
|
||||||
|
|
||||||
1. Ensure you have the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli/reference/ibmcloud/download_cli.html#install_use) installed.
|
If you do not want your container image to be publicly available, you may want
|
||||||
|
to use a private container registry. In this example, we'll use IBM Container
|
||||||
|
Registry, but most of these concepts will be similar for other clouds.
|
||||||
|
|
||||||
|
1. Ensure you have the
|
||||||
|
[IBM Cloud CLI](https://cloud.ibm.com/docs/cli/reference/ibmcloud/download_cli.html#install_use)
|
||||||
|
installed.
|
||||||
|
|
||||||
1. Install the container registry plugin:
|
1. Install the container registry plugin:
|
||||||
|
|
||||||
|
@ -31,7 +41,9 @@ If you do not want your container image to be publicly available, you may want t
|
||||||
ibmcloud cr namespace-add <my_namespace>
|
ibmcloud cr namespace-add <my_namespace>
|
||||||
```
|
```
|
||||||
|
|
||||||
A namespace represents the spot within a registry that holds your images. You can set up multiple namespaces as well as control access to your namespaces by using IAM policies.
|
A namespace represents the spot within a registry that holds your images. You
|
||||||
|
can set up multiple namespaces as well as control access to your namespaces
|
||||||
|
by using IAM policies.
|
||||||
|
|
||||||
1. Create a token:
|
1. Create a token:
|
||||||
|
|
||||||
|
@ -39,18 +51,26 @@ If you do not want your container image to be publicly available, you may want t
|
||||||
ibmcloud cr token-add --description "token description" --non-expiring --readwrite
|
ibmcloud cr token-add --description "token description" --non-expiring --readwrite
|
||||||
```
|
```
|
||||||
|
|
||||||
The automated build processes you'll be setting up will use this token to access your images.
|
The automated build processes you'll be setting up will use this token to
|
||||||
|
access your images.
|
||||||
|
|
||||||
1. The CLI output should include a token identifier and the token. Make note of the token. You can verify that the token was created by listing all tokens:
|
1. The CLI output should include a token identifier and the token. Make note of
|
||||||
|
the token. You can verify that the token was created by listing all tokens:
|
||||||
|
|
||||||
```
|
```
|
||||||
ibmcloud cr token-list
|
ibmcloud cr token-list
|
||||||
```
|
```
|
||||||
|
|
||||||
## Provide container registry credentials to Knative
|
## Provide container registry credentials to Knative
|
||||||
You will use the credentials you obtained in the previous section to authenticate to your private container registry. First, you'll need to create a secret to store the credentials for this registry. This secret will be used to push the built image to the container registry.
|
|
||||||
|
|
||||||
A Secret is a Kubernetes object containing sensitive data such as a password, a token, or a key. You can also read more about [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/).
|
You will use the credentials you obtained in the previous section to
|
||||||
|
authenticate to your private container registry. First, you'll need to create a
|
||||||
|
secret to store the credentials for this registry. This secret will be used to
|
||||||
|
push the built image to the container registry.
|
||||||
|
|
||||||
|
A Secret is a Kubernetes object containing sensitive data such as a password, a
|
||||||
|
token, or a key. You can also read more about
|
||||||
|
[Secrets](https://kubernetes.io/docs/concepts/configuration/secret/).
|
||||||
|
|
||||||
1. Create a file named `registry-push-secret.yaml` containing the following:
|
1. Create a file named `registry-push-secret.yaml` containing the following:
|
||||||
|
|
||||||
|
@ -67,7 +87,8 @@ A Secret is a Kubernetes object containing sensitive data such as a password, a
|
||||||
password: <token_value>
|
password: <token_value>
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Update the "password" with your <token_value>. Note that username will be the string `token`. Save the file.
|
1. Update the "password" with your <token_value>. Note that username will be the
|
||||||
|
string `token`. Save the file.
|
||||||
|
|
||||||
1. Apply the secret to your cluster.
|
1. Apply the secret to your cluster.
|
||||||
|
|
||||||
|
@ -75,13 +96,19 @@ A Secret is a Kubernetes object containing sensitive data such as a password, a
|
||||||
kubectl apply --filename registry-push-secret.yaml
|
kubectl apply --filename registry-push-secret.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
1. You will also need a secret for the knative-serving component to pull down an image from the private container registry. This secret will be a `docker-registry` type secret. You can create this via the commandline. For username, simply use the string `token`. For <token_value>, use the token you made note of earlier.
|
1. You will also need a secret for the knative-serving component to pull down an
|
||||||
|
image from the private container registry. This secret will be a
|
||||||
|
`docker-registry` type secret. You can create this via the commandline. For
|
||||||
|
username, simply use the string `token`. For <token_value>, use the token you
|
||||||
|
made note of earlier.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl create secret docker-registry ibm-cr-secret --docker-server=https://registry.ng.bluemix.net --docker-username=token --docker-password=<token_value>
|
kubectl create secret docker-registry ibm-cr-secret --docker-server=https://registry.ng.bluemix.net --docker-username=token --docker-password=<token_value>
|
||||||
```
|
```
|
||||||
|
|
||||||
A Service Account provides an identity for processes that run in a Pod. This Service Account will be used to link the build process for Knative to the Secrets you just created.
|
A Service Account provides an identity for processes that run in a Pod. This
|
||||||
|
Service Account will be used to link the build process for Knative to the
|
||||||
|
Secrets you just created.
|
||||||
|
|
||||||
1. Create a file named `service-account.yaml` containing the following:
|
1. Create a file named `service-account.yaml` containing the following:
|
||||||
|
|
||||||
|
@ -103,7 +130,9 @@ A Service Account provides an identity for processes that run in a Pod. This Ser
|
||||||
```
|
```
|
||||||
|
|
||||||
## Deploy to Knative
|
## Deploy to Knative
|
||||||
To build our application from the source on GitHub, and push the resulting image to the IBM Container Registry, we will use the Kaniko build template.
|
|
||||||
|
To build our application from the source on GitHub, and push the resulting image
|
||||||
|
to the IBM Container Registry, we will use the Kaniko build template.
|
||||||
|
|
||||||
1. Install the Kaniko build template
|
1. Install the Kaniko build template
|
||||||
|
|
||||||
|
@ -111,7 +140,10 @@ To build our application from the source on GitHub, and push the resulting image
|
||||||
kubectl apply --filename https://raw.githubusercontent.com/knative/build-templates/master/kaniko/kaniko.yaml
|
kubectl apply --filename https://raw.githubusercontent.com/knative/build-templates/master/kaniko/kaniko.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
1. You need to create a service manifest which defines the service to deploy, including where the source code is and which build-template to use. Create a file named `service.yaml` and copy the following definition. Make sure to replace {NAMESPACE} with your own namespace you created earlier:
|
1. You need to create a service manifest which defines the service to deploy,
|
||||||
|
including where the source code is and which build-template to use. Create a
|
||||||
|
file named `service.yaml` and copy the following definition. Make sure to
|
||||||
|
replace {NAMESPACE} with your own namespace you created earlier:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
apiVersion: serving.knative.dev/v1alpha1
|
apiVersion: serving.knative.dev/v1alpha1
|
||||||
|
@ -155,21 +187,26 @@ To build our application from the source on GitHub, and push the resulting image
|
||||||
```
|
```
|
||||||
|
|
||||||
Applying this service definition will kick off a series of events:
|
Applying this service definition will kick off a series of events:
|
||||||
- Fetches the revision specified from GitHub and builds it into a container, using the Kaniko build template.
|
|
||||||
- Pushes the latest image to the private registry using the registry-push-secret
|
|
||||||
- Pulls down the latest image from the private registry using the ibm-cr-secret.
|
|
||||||
- Starts the service, and your app will be live.
|
|
||||||
|
|
||||||
|
- Fetches the revision specified from GitHub and builds it into a container,
|
||||||
|
using the Kaniko build template.
|
||||||
|
- Pushes the latest image to the private registry using the
|
||||||
|
registry-push-secret
|
||||||
|
- Pulls down the latest image from the private registry using the
|
||||||
|
ibm-cr-secret.
|
||||||
|
- Starts the service, and your app will be live.
|
||||||
|
|
||||||
1. You can run `kubectl get pods --watch` to see the pods initializing.
|
1. You can run `kubectl get pods --watch` to see the pods initializing.
|
||||||
|
|
||||||
1. Once all the pods are initialized, you can see that your container image was built and pushed to the IBM Container Registry:
|
1. Once all the pods are initialized, you can see that your container image was
|
||||||
|
built and pushed to the IBM Container Registry:
|
||||||
|
|
||||||
```
|
```
|
||||||
ibmcloud cr image-list
|
ibmcloud cr image-list
|
||||||
```
|
```
|
||||||
|
|
||||||
## Test Application Behavior
|
## Test Application Behavior
|
||||||
|
|
||||||
1. Run the following command to find the external IP address for your service:
|
1. Run the following command to find the external IP address for your service:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|
|
@ -45,9 +45,9 @@ which allows sending logs to Stackdriver.
|
||||||
|
|
||||||
Operators can build this image and push it to a container registry which their
|
Operators can build this image and push it to a container registry which their
|
||||||
Kubernetes cluster has access to. See
|
Kubernetes cluster has access to. See
|
||||||
[Setting Up A Logging Plugin](../setting-up-a-logging-plugin.md) for
|
[Setting Up A Logging Plugin](../setting-up-a-logging-plugin.md) for details.
|
||||||
details. **NOTE**: Operators need to add credentials file the stackdriver agent
|
**NOTE**: Operators need to add credentials file the stackdriver agent needs to
|
||||||
needs to the docker image if their Knative Serving is not built on a GCP based
|
the docker image if their Knative Serving is not built on a GCP based cluster or
|
||||||
cluster or they want to send logs to another GCP project. See
|
they want to send logs to another GCP project. See
|
||||||
[here](https://cloud.google.com/logging/docs/agent/authorization) for more
|
[here](https://cloud.google.com/logging/docs/agent/authorization) for more
|
||||||
information.
|
information.
|
||||||
|
|
|
@ -35,7 +35,9 @@ Using the Google Cloud SDK:
|
||||||
```shell
|
```shell
|
||||||
gcloud beta compute addresses create IP_NAME --region=REGION
|
gcloud beta compute addresses create IP_NAME --region=REGION
|
||||||
```
|
```
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
gcloud beta compute addresses create knative-ip --region=us-west1
|
gcloud beta compute addresses create knative-ip --region=us-west1
|
||||||
```
|
```
|
||||||
|
|
|
@ -158,8 +158,8 @@ To configure and setup monitoring:
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Choose a container image that meets the
|
1. Choose a container image that meets the
|
||||||
[Fluentd image requirements](./fluentd-requirements.md#requirements).
|
[Fluentd image requirements](./fluentd-requirements.md#requirements). For
|
||||||
For example, you can use a public image. Or you can create a custom one and
|
example, you can use a public image. Or you can create a custom one and
|
||||||
upload the image to a container registry which your cluster has read access
|
upload the image to a container registry which your cluster has read access
|
||||||
to.
|
to.
|
||||||
|
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
Use the following sample applications to help you understand the various
|
Use the following sample applications to help you understand the various Knative
|
||||||
Knative Serving resources and how they can be applied across common use cases.
|
Serving resources and how they can be applied across common use cases.
|
||||||
[Learn more about Knative Serving resources](../README.md).
|
[Learn more about Knative Serving resources](../README.md).
|
||||||
|
|
||||||
| Name | Description | Languages |
|
| Name | Description | Languages |
|
||||||
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||||
| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/README.md), [Go](./hello-world/helloworld-go/README.md), [Java](./hello-world/helloworld-java/README.md), [Kotlin](./hello-world/helloworld-kotlin/README.md), [Node.js](./hello-world/helloworld-nodejs/README.md), [PHP](./hello-world/helloworld-php/README.md), [Python](./hello-world/helloworld-python/README.md), [Ruby](./hello-world/helloworld-ruby/README.md), [Scala](./hello-world/helloworld-scala/README.md) |
|
| Hello World | A quick introduction that highlights how to deploy an app using Knative Serving. | [C#](./hello-world/helloworld-csharp/README.md), [Go](./hello-world/helloworld-go/README.md), [Java](./hello-world/helloworld-java/README.md), [Kotlin](./hello-world/helloworld-kotlin/README.md), [Node.js](./hello-world/helloworld-nodejs/README.md), [PHP](./hello-world/helloworld-php/README.md), [Python](./hello-world/helloworld-python/README.md), [Ruby](./hello-world/helloworld-ruby/README.md), [Scala](./hello-world/helloworld-scala/README.md) |
|
||||||
| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment.md) |
|
| Advanced Deployment | Simple blue/green-like application deployment pattern illustrating the process of updating a live application without dropping any traffic. | [YAML](./blue-green-deployment.md) |
|
||||||
| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](./autoscale-go/README.md) |
|
| Autoscale | A demonstration of the autoscaling capabilities of Knative. | [Go](./autoscale-go/README.md) |
|
||||||
|
|
|
@ -1,13 +1,11 @@
|
||||||
|
|
||||||
A demonstration of the autoscaling capabilities of a Knative Serving Revision.
|
A demonstration of the autoscaling capabilities of a Knative Serving Revision.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. A Kubernetes cluster with [Knative Serving](../../../install/README.md)
|
1. A Kubernetes cluster with [Knative Serving](../../../install/README.md)
|
||||||
installed.
|
installed.
|
||||||
1. A
|
1. A [metrics installation](../../installing-logging-metrics-traces.md) for
|
||||||
[metrics installation](../../installing-logging-metrics-traces.md)
|
viewing scaling graphs (optional).
|
||||||
for viewing scaling graphs (optional).
|
|
||||||
1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`).
|
1. The `hey` load generator installed (`go get -u github.com/rakyll/hey`).
|
||||||
1. Clone this repository, and move into the sample directory:
|
1. Clone this repository, and move into the sample directory:
|
||||||
|
|
||||||
|
|
|
@ -15,8 +15,7 @@ configuration.
|
||||||
You need:
|
You need:
|
||||||
|
|
||||||
- A Kubernetes cluster with [Knative installed](../../install/README.md).
|
- A Kubernetes cluster with [Knative installed](../../install/README.md).
|
||||||
- (Optional)
|
- (Optional) [A custom domain configured](../using-a-custom-domain.md) for use
|
||||||
[A custom domain configured](../using-a-custom-domain.md) for use
|
|
||||||
with Knative.
|
with Knative.
|
||||||
|
|
||||||
Note: The source code for the gcr.io/knative-samples/knative-route-demo image
|
Note: The source code for the gcr.io/knative-samples/knative-route-demo image
|
||||||
|
@ -85,9 +84,8 @@ route "blue-green-demo" configured
|
||||||
|
|
||||||
You'll now be able to view the sample app at
|
You'll now be able to view the sample app at
|
||||||
http://blue-green-demo.default.YOUR_CUSTOM_DOMAIN.com (replace
|
http://blue-green-demo.default.YOUR_CUSTOM_DOMAIN.com (replace
|
||||||
`YOUR_CUSTOM_DOMAIN`) with the
|
`YOUR_CUSTOM_DOMAIN`) with the [custom domain](../using-a-custom-domain.md) you
|
||||||
[custom domain](../using-a-custom-domain.md) you configured for use
|
configured for use with Knative.
|
||||||
with Knative.
|
|
||||||
|
|
||||||
> Note: If you don't have a custom domain configured for use with Knative, you
|
> Note: If you don't have a custom domain configured for use with Knative, you
|
||||||
> can interact with your app using cURL requests if you have the host URL and IP
|
> can interact with your app using cURL requests if you have the host URL and IP
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This sample demonstrates:
|
This sample demonstrates:
|
||||||
|
|
||||||
- Pulling source code from a private Github repository using a deploy-key
|
- Pulling source code from a private Github repository using a deploy-key
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A sample app that demonstrates using
|
A sample app that demonstrates using
|
||||||
[Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving,
|
[Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving,
|
||||||
using the [packs Docker images](https://github.com/sclevine/packs).
|
using the [packs Docker images](https://github.com/sclevine/packs).
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A sample function that demonstrates using
|
A sample function that demonstrates using
|
||||||
[Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving,
|
[Cloud Foundry](https://www.cloudfoundry.org/) buildpacks on Knative Serving,
|
||||||
using the [packs Docker images](https://github.com/sclevine/packs).
|
using the [packs Docker images](https://github.com/sclevine/packs).
|
||||||
|
|
|
@ -1,12 +1,11 @@
|
||||||
|
|
||||||
A handler written in Go that demonstrates interacting with GitHub through a
|
A handler written in Go that demonstrates interacting with GitHub through a
|
||||||
webhook.
|
webhook.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- An account on [GitHub](https://github.com) with read/write access to a
|
- An account on [GitHub](https://github.com) with read/write access to a
|
||||||
|
@ -97,8 +96,7 @@ service "gitwebhook" created
|
||||||
|
|
||||||
1. Finally, once the service is running, create the webhook from your GitHub
|
1. Finally, once the service is running, create the webhook from your GitHub
|
||||||
repo to the URL for this service. For this to work properly you will need to
|
repo to the URL for this service. For this to work properly you will need to
|
||||||
[configure a custom domain](../../using-a-custom-domain.md)
|
[configure a custom domain](../../using-a-custom-domain.md) and
|
||||||
and
|
|
||||||
[assign a static IP address](../../gke-assigning-static-ip-address.md).
|
[assign a static IP address](../../gke-assigning-static-ip-address.md).
|
||||||
|
|
||||||
1. Retrieve the hostname for this service, using the following command:
|
1. Retrieve the hostname for this service, using the following command:
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple gRPC server written in Go that you can use for testing.
|
A simple gRPC server written in Go that you can use for testing.
|
||||||
|
|
||||||
This sample requires knative/serving 0.4 or later.
|
This sample requires knative/serving 0.4 or later.
|
||||||
|
|
|
@ -4,4 +4,3 @@ linkTitle: "Hello world apps"
|
||||||
weight: 1
|
weight: 1
|
||||||
type: "docs"
|
type: "docs"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in C# using .NET Core 2.2 that you can use for testing.
|
A simple web app written in C# using .NET Core 2.2 that you can use for testing.
|
||||||
It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET
|
It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET
|
||||||
is not specified, it will use "World" as the TARGET.
|
is not specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ is not specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- You have installed [.NET Core SDK 2.2](https://www.microsoft.com/net/core).
|
- You have installed [.NET Core SDK 2.2](https://www.microsoft.com/net/core).
|
||||||
|
@ -18,7 +17,8 @@ While you can clone all of the code from this directory, hello world apps are
|
||||||
generally more useful if you build them step-by-step. The following instructions
|
generally more useful if you build them step-by-step. The following instructions
|
||||||
recreate the source files from this folder.
|
recreate the source files from this folder.
|
||||||
|
|
||||||
1. First, make sure you have [.NET Core SDK 2.2](https://www.microsoft.com/net/core) installed:
|
1. First, make sure you have
|
||||||
|
[.NET Core SDK 2.2](https://www.microsoft.com/net/core) installed:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
dotnet --version
|
dotnet --version
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Go that you can use for testing. It reads in an env
|
A simple web app written in Go that you can use for testing. It reads in an env
|
||||||
variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified,
|
variable `TARGET` and prints `Hello ${TARGET}!`. If `TARGET` is not specified,
|
||||||
it will use `World` as the `TARGET`.
|
it will use `World` as the `TARGET`.
|
||||||
|
@ -6,8 +5,8 @@ it will use `World` as the `TARGET`.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Java using Spring Boot 2.0 that you can use for
|
A simple web app written in Java using Spring Boot 2.0 that you can use for
|
||||||
testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If
|
testing. It reads in an env variable `TARGET` and prints "Hello \${TARGET}!". If
|
||||||
TARGET is not specified, it will use "World" as the TARGET.
|
TARGET is not specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ TARGET is not specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- You have installed
|
- You have installed
|
||||||
|
@ -207,9 +206,8 @@ folder) you're ready to build and deploy the sample app.
|
||||||
--output jsonpath={.status.domain}
|
--output jsonpath={.status.domain}
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Now you can make a request to your app to see the result. Presuming,
|
1. Now you can make a request to your app to see the result. Presuming, the IP
|
||||||
the IP address you got in the step above is in the `${IP_ADDRESS}`
|
address you got in the step above is in the `${IP_ADDRESS}` env variable:
|
||||||
env variable:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -H "Host: ${DOMAIN_NAME}" http://${IP_ADDRESS}
|
curl -H "Host: ${DOMAIN_NAME}" http://${IP_ADDRESS}
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Kotlin using [Ktor](https://ktor.io/) that you can
|
A simple web app written in Kotlin using [Ktor](https://ktor.io/) that you can
|
||||||
use for testing. It reads in an env variable `TARGET` and prints "Hello
|
use for testing. It reads in an env variable `TARGET` and prints "Hello
|
||||||
\${TARGET}". If TARGET is not specified, it will use "World" as the TARGET.
|
\${TARGET}". If TARGET is not specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ use for testing. It reads in an env variable `TARGET` and prints "Hello
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
@ -215,9 +214,8 @@ folder) you're ready to build and deploy the sample app.
|
||||||
helloworld-kotlin helloworld-kotlin.default.example.com
|
helloworld-kotlin helloworld-kotlin.default.example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Now you can make a request to your app to see the result. Presuming,
|
1. Now you can make a request to your app to see the result. Presuming, the IP
|
||||||
the IP address you got in the step above is in the `${IP_ADDRESS}`
|
address you got in the step above is in the `${IP_ADDRESS}` env variable:
|
||||||
env variable:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -H "Host: helloworld-kotlin.default.example.com" http://${IP_ADDRESS}
|
curl -H "Host: helloworld-kotlin.default.example.com" http://${IP_ADDRESS}
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Node.js that you can use for testing. It reads in an
|
A simple web app written in Node.js that you can use for testing. It reads in an
|
||||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||||
specified, it will use "World" as the TARGET.
|
specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- [Node.js](https://nodejs.org/en/) installed and configured.
|
- [Node.js](https://nodejs.org/en/) installed and configured.
|
||||||
|
@ -18,7 +17,6 @@ While you can clone all of the code from this directory, hello world apps are
|
||||||
generally more useful if you build them step-by-step. The following instructions
|
generally more useful if you build them step-by-step. The following instructions
|
||||||
recreate the source files from this folder.
|
recreate the source files from this folder.
|
||||||
|
|
||||||
|
|
||||||
1. Create a new directory and initialize `npm`:
|
1. Create a new directory and initialize `npm`:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in PHP that you can use for testing. It reads in an env
|
A simple web app written in PHP that you can use for testing. It reads in an env
|
||||||
variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it
|
variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not specified, it
|
||||||
will use "World" as the TARGET.
|
will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Python that you can use for testing. It reads in an
|
A simple web app written in Python that you can use for testing. It reads in an
|
||||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||||
specified, it will use "World" as the TARGET.
|
specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A simple web app written in Ruby that you can use for testing. It reads in an
|
A simple web app written in Ruby that you can use for testing. It reads in an
|
||||||
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
env variable `TARGET` and prints "Hello \${TARGET}!". If TARGET is not
|
||||||
specified, it will use "World" as the TARGET.
|
specified, it will use "World" as the TARGET.
|
||||||
|
@ -6,8 +5,8 @@ specified, it will use "World" as the TARGET.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../../install/README.md)
|
[installation instructions](../../../../install/README.md) if you need to
|
||||||
if you need to create one.
|
create one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A microservice which demonstrates how to get set up and running with Knative
|
A microservice which demonstrates how to get set up and running with Knative
|
||||||
Serving when using [Scala](https://scala-lang.org/) and [Akka](https://akka.io/)
|
Serving when using [Scala](https://scala-lang.org/) and [Akka](https://akka.io/)
|
||||||
[HTTP](https://doc.akka.io/docs/akka-http/current/). It will respond to a HTTP
|
[HTTP](https://doc.akka.io/docs/akka-http/current/). It will respond to a HTTP
|
||||||
|
@ -7,9 +6,8 @@ to `"Hello World!"`.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster
|
- A Kubernetes cluster [installation](../../../../install/README.md) with
|
||||||
[installation](../../../../install/README.md)
|
Knative Serving up and running.
|
||||||
with Knative Serving up and running.
|
|
||||||
- [Docker](https://www.docker.com) installed locally, and running, optionally a
|
- [Docker](https://www.docker.com) installed locally, and running, optionally a
|
||||||
Docker Hub account configured or some other Docker Repository installed
|
Docker Hub account configured or some other Docker Repository installed
|
||||||
locally.
|
locally.
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This example shows how to map multiple Knative services to different paths under
|
This example shows how to map multiple Knative services to different paths under
|
||||||
a single domain name using the Istio VirtualService concept. Istio is a
|
a single domain name using the Istio VirtualService concept. Istio is a
|
||||||
general-purpose reverse proxy, therefore these directions can also be used to
|
general-purpose reverse proxy, therefore these directions can also be used to
|
||||||
|
@ -14,8 +13,7 @@ the Login service.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. A Kubernetes cluster with
|
1. A Kubernetes cluster with [Knative Serving](../../../install/README.md)
|
||||||
[Knative Serving](../../../install/README.md)
|
|
||||||
installed.
|
installed.
|
||||||
2. Install
|
2. Install
|
||||||
[Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment).
|
[Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment).
|
||||||
|
@ -67,7 +65,8 @@ docker push "${REPO}/docs/serving/samples/knative-routing-go"
|
||||||
configuration file `docs/serving/samples/knative-routing-go/sample.yaml`:
|
configuration file `docs/serving/samples/knative-routing-go/sample.yaml`:
|
||||||
|
|
||||||
- Manually replace:
|
- Manually replace:
|
||||||
`image: github.com/knative/docs/docs/serving/samples/knative-routing-go` with
|
`image: github.com/knative/docs/docs/serving/samples/knative-routing-go`
|
||||||
|
with
|
||||||
`image: <YOUR_CONTAINER_REGISTRY>docs/serving/samples/knative-routing-go`
|
`image: <YOUR_CONTAINER_REGISTRY>docs/serving/samples/knative-routing-go`
|
||||||
|
|
||||||
Or
|
Or
|
||||||
|
|
|
@ -1,17 +1,15 @@
|
||||||
|
|
||||||
This sample demonstrates creating and running a simple RESTful service on
|
This sample demonstrates creating and running a simple RESTful service on
|
||||||
Knative Serving. The exposed endpoint takes a stock ticker (i.e. stock symbol),
|
Knative Serving. The exposed endpoint takes a stock ticker (i.e. stock symbol),
|
||||||
then outputs the stock price.
|
then outputs the stock price.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. A Kubernetes cluster with
|
1. A Kubernetes cluster with [Knative Serving](../../../install/README.md) v0.3
|
||||||
[Knative Serving](../../../install/README.md)
|
or higher installed.
|
||||||
v0.3 or higher installed.
|
|
||||||
1. [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment)
|
1. [Docker](https://docs.docker.com/get-started/#prepare-your-docker-environment)
|
||||||
installed locally.
|
installed locally.
|
||||||
1. [Outbound network access](../../outbound-network-access.md)
|
1. [Outbound network access](../../outbound-network-access.md) enabled for this
|
||||||
enabled for this Service to make external API requests.
|
Service to make external API requests.
|
||||||
1. The code checked out locally.
|
1. The code checked out locally.
|
||||||
1. `envsubst` installed locally. This is installed by the `gettext` package. If
|
1. `envsubst` installed locally. This is installed by the `gettext` package. If
|
||||||
not installed it can be installed by a Linux package manager, or by
|
not installed it can be installed by a Linux package manager, or by
|
||||||
|
@ -28,8 +26,7 @@ available to fetch from a container registry. Building and pushing a container
|
||||||
image can be accomplished locally using
|
image can be accomplished locally using
|
||||||
[Docker](https://docs.docker.com/get-started) or
|
[Docker](https://docs.docker.com/get-started) or
|
||||||
[ko](https://github.com/google/go-containerregistry/tree/master/cmd/ko) as well
|
[ko](https://github.com/google/go-containerregistry/tree/master/cmd/ko) as well
|
||||||
as remotely using
|
as remotely using [Knative Build](../../../build).
|
||||||
[Knative Build](../../../build).
|
|
||||||
|
|
||||||
This sample uses Docker for both building and pushing.
|
This sample uses Docker for both building and pushing.
|
||||||
|
|
||||||
|
@ -79,7 +76,7 @@ docker push "${REPO}/rest-api-go"
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Substitute the image reference path in the template with our published image
|
6. Substitute the image reference path in the template with our published image
|
||||||
path. The command below substitutes using the ${REPO} variable into a new
|
path. The command below substitutes using the \${REPO} variable into a new
|
||||||
file called `docs/serving/samples/rest-api-go/sample.yaml`.
|
file called `docs/serving/samples/rest-api-go/sample.yaml`.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
@ -92,7 +89,6 @@ docker push "${REPO}/rest-api-go"
|
||||||
Now that our image is available from the container registry, we can deploy the
|
Now that our image is available from the container registry, we can deploy the
|
||||||
Knative Serving sample:
|
Knative Serving sample:
|
||||||
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl apply --filename docs/serving/samples/rest-api-go/sample.yaml
|
kubectl apply --filename docs/serving/samples/rest-api-go/sample.yaml
|
||||||
```
|
```
|
||||||
|
@ -177,10 +173,10 @@ echo $INGRESS_IP
|
||||||
|
|
||||||
#### Minikube
|
#### Minikube
|
||||||
|
|
||||||
1. If your cluster is running outside a cloud provider (for example on Minikube),
|
1. If your cluster is running outside a cloud provider (for example on
|
||||||
your services will never get an external IP address, and your INGRESS_IP will
|
Minikube), your services will never get an external IP address, and your
|
||||||
be empty. In that case, use the istio `hostIP` and `nodePort` as the ingress
|
INGRESS_IP will be empty. In that case, use the istio `hostIP` and `nodePort`
|
||||||
IP:
|
as the ingress IP:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
export INGRESS_IP=$(kubectl get po --selector $INGRESSGATEWAY_LABEL=ingressgateway --namespace istio-system \
|
export INGRESS_IP=$(kubectl get po --selector $INGRESSGATEWAY_LABEL=ingressgateway --namespace istio-system \
|
||||||
|
@ -233,16 +229,14 @@ Response body: `stock price for ticker <ticker> is <price>`
|
||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
The
|
The [traffic splitting example](../traffic-splitting/README.md) continues from
|
||||||
[traffic splitting example](../traffic-splitting/README.md)
|
here to walk through creating new Revisions and splitting traffic between
|
||||||
continues from here to walk through creating new Revisions and splitting traffic
|
multiple Revisions.
|
||||||
between multiple Revisions.
|
|
||||||
|
|
||||||
## Clean Up
|
## Clean Up
|
||||||
|
|
||||||
To clean up the sample Service:
|
To clean up the sample Service:
|
||||||
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl delete --filename docs/serving/samples/rest-api-go/sample.yaml
|
kubectl delete --filename docs/serving/samples/rest-api-go/sample.yaml
|
||||||
```
|
```
|
||||||
|
|
|
@ -8,8 +8,8 @@ into a container as a Volume.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- [Docker](https://www.docker.com) installed and running on your local machine,
|
- [Docker](https://www.docker.com) installed and running on your local machine,
|
||||||
and a Docker Hub account configured (we'll use it for a container registry).
|
and a Docker Hub account configured (we'll use it for a container registry).
|
||||||
- Create a
|
- Create a
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
A Go sample that shows how to use Knative to go from source code in a git
|
A Go sample that shows how to use Knative to go from source code in a git
|
||||||
repository to a running application with a URL.
|
repository to a running application with a URL.
|
||||||
|
|
||||||
|
@ -11,8 +10,8 @@ deployment.
|
||||||
You need:
|
You need:
|
||||||
|
|
||||||
- A Kubernetes cluster with Knative installed. Follow the
|
- A Kubernetes cluster with Knative installed. Follow the
|
||||||
[installation instructions](../../../install/README.md)
|
[installation instructions](../../../install/README.md) if you need to create
|
||||||
if you need to create one.
|
one.
|
||||||
- Go installed and configured. This is optional, and only required if you want
|
- Go installed and configured. This is optional, and only required if you want
|
||||||
to run the sample app locally.
|
to run the sample app locally.
|
||||||
|
|
||||||
|
@ -86,7 +85,8 @@ available, but these are the key steps:
|
||||||
- name: basic-user-pass
|
- name: basic-user-pass
|
||||||
```
|
```
|
||||||
|
|
||||||
1. After you have created the manifest files, apply them to your cluster with `kubectl`:
|
1. After you have created the manifest files, apply them to your cluster with
|
||||||
|
`kubectl`:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ kubectl apply --filename docker-secret.yaml
|
$ kubectl apply --filename docker-secret.yaml
|
||||||
|
@ -166,7 +166,9 @@ container for the application.
|
||||||
app-from-source-00001-deployment-6d6ff665f9-xfhm5 3/3 Running 0 11s
|
app-from-source-00001-deployment-6d6ff665f9-xfhm5 3/3 Running 0 11s
|
||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** If the build pod never reaches Completed status and terminates after 10 minutes, Kaniko probably didn't finish pulling the build image within the default timeout period. Try increasing the `timeout` value in `service.yaml`.
|
> **Note:** If the build pod never reaches Completed status and terminates after
|
||||||
|
> 10 minutes, Kaniko probably didn't finish pulling the build image within the
|
||||||
|
> default timeout period. Try increasing the `timeout` value in `service.yaml`.
|
||||||
|
|
||||||
1. Once you see the deployment pod switch to the running state, press Ctrl+C to
|
1. Once you see the deployment pod switch to the running state, press Ctrl+C to
|
||||||
escape the watch. Your container is now built and deployed!
|
escape the watch. Your container is now built and deployed!
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This sample runs a simple web server that makes calls to other in-cluster
|
This sample runs a simple web server that makes calls to other in-cluster
|
||||||
services and responds to requests with "Hello World!". The purpose of this
|
services and responds to requests with "Hello World!". The purpose of this
|
||||||
sample is to show generating [metrics](../../accessing-metrics.md),
|
sample is to show generating [metrics](../../accessing-metrics.md),
|
||||||
|
@ -8,8 +7,7 @@ dedicated Prometheus instance rather than using the default installation.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
1. A Kubernetes cluster with
|
1. A Kubernetes cluster with [Knative Serving](../../../install/README.md)
|
||||||
[Knative Serving](../../../install/README.md)
|
|
||||||
installed.
|
installed.
|
||||||
2. Check if Knative monitoring components are installed:
|
2. Check if Knative monitoring components are installed:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This is a walk-through example that demonstrates deploying a dockerized
|
This is a walk-through example that demonstrates deploying a dockerized
|
||||||
application that accesses external dependencies to Knative Serving. In this demo
|
application that accesses external dependencies to Knative Serving. In this demo
|
||||||
we will use a sample `golang` application that takes a video URL as an input and
|
we will use a sample `golang` application that takes a video URL as an input and
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
|
|
||||||
This samples builds off the [Creating a RESTful Service](../rest-api-go) sample
|
This samples builds off the [Creating a RESTful Service](../rest-api-go) sample
|
||||||
to illustrate applying a revision, then using that revision for manual traffic
|
to illustrate applying a revision, then using that revision for manual traffic
|
||||||
splitting.
|
splitting.
|
||||||
|
@ -103,7 +102,8 @@ stock-configuration-example-00001 11m
|
||||||
stock-configuration-example-00002 4m
|
stock-configuration-example-00002 4m
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Update the `traffic` list in `docs/serving/samples/rest-api-go/sample.yaml` as:
|
2. Update the `traffic` list in `docs/serving/samples/rest-api-go/sample.yaml`
|
||||||
|
as:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
traffic:
|
traffic:
|
||||||
|
|
|
@ -36,8 +36,8 @@ collecting `stdout/stderr` logs from the containers:
|
||||||
in
|
in
|
||||||
[200-fluentd.yaml](https://github.com/knative/serving/blob/master/config/monitoring/logging/elasticsearch/200-fluentd.yaml)
|
[200-fluentd.yaml](https://github.com/knative/serving/blob/master/config/monitoring/logging/elasticsearch/200-fluentd.yaml)
|
||||||
with the Fluentd image including the desired Fluentd output plugin. See
|
with the Fluentd image including the desired Fluentd output plugin. See
|
||||||
[here](./fluentd-requirements.md) for the requirements of Flunetd
|
[here](./fluentd-requirements.md) for the requirements of Flunetd image on
|
||||||
image on Knative.
|
Knative.
|
||||||
|
|
||||||
### Configure the Sidecar for log files under /var/log
|
### Configure the Sidecar for log files under /var/log
|
||||||
|
|
||||||
|
@ -71,7 +71,8 @@ kubectl apply --recursive --filename config/monitoring/100-namespace.yaml \
|
||||||
```
|
```
|
||||||
|
|
||||||
In the commands above, replace `<path-of-fluentd-daemonset-config>` with the
|
In the commands above, replace `<path-of-fluentd-daemonset-config>` with the
|
||||||
Fluentd DaemonSet configuration file, e.g. `config/monitoring/logging/stackdriver`.
|
Fluentd DaemonSet configuration file, e.g.
|
||||||
|
`config/monitoring/logging/stackdriver`.
|
||||||
|
|
||||||
**NOTE**: The deployment above will not affect the fluentd sidecar of existing
|
**NOTE**: The deployment above will not affect the fluentd sidecar of existing
|
||||||
pods. Developers need to redeploy their app to get the newest configuration for
|
pods. Developers need to redeploy their app to get the newest configuration for
|
||||||
|
@ -85,8 +86,8 @@ the Elasticsearch and Kibana services. Knative provides this sample:
|
||||||
kubectl apply --recursive --filename third_party/config/monitoring/logging/elasticsearch
|
kubectl apply --recursive --filename third_party/config/monitoring/logging/elasticsearch
|
||||||
```
|
```
|
||||||
|
|
||||||
See [here](./installing-logging-metrics-traces.md) for deploying the
|
See [here](./installing-logging-metrics-traces.md) for deploying the whole
|
||||||
whole Knative monitoring components.
|
Knative monitoring components.
|
||||||
|
|
||||||
## Uninstalling
|
## Uninstalling
|
||||||
|
|
||||||
|
|
|
@ -244,7 +244,8 @@ namespace:
|
||||||
kubectl edit configmap config-ingressgateway -n knative-serving
|
kubectl edit configmap config-ingressgateway -n knative-serving
|
||||||
```
|
```
|
||||||
|
|
||||||
Replace the `ingress-gateway` field with the fully qualified url of your service. For the service above, it should be updated to:
|
Replace the `ingress-gateway` field with the fully qualified url of your
|
||||||
|
service. For the service above, it should be updated to:
|
||||||
|
|
||||||
```
|
```
|
||||||
custom-ingressgateway.istio-system.svc.cluster.local
|
custom-ingressgateway.istio-system.svc.cluster.local
|
||||||
|
|
|
@ -82,9 +82,9 @@ You can also apply an updated domain configuration:
|
||||||
> deployed services and routes.
|
> deployed services and routes.
|
||||||
|
|
||||||
Deploy an app (for example,
|
Deploy an app (for example,
|
||||||
[`helloworld-go`](./samples/hello-world/helloworld-go/README.md)), to your cluster as
|
[`helloworld-go`](./samples/hello-world/helloworld-go/README.md)), to your
|
||||||
normal. You can check the customized domain in Knative Route "helloworld-go"
|
cluster as normal. You can check the customized domain in Knative Route
|
||||||
with the following command:
|
"helloworld-go" with the following command:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
kubectl get route helloworld-go --output jsonpath="{.status.domain}"
|
kubectl get route helloworld-go --output jsonpath="{.status.domain}"
|
||||||
|
|
|
@ -7,8 +7,8 @@ type: "docs"
|
||||||
|
|
||||||
These instructions assume you have already setup a Knative cluster and installed
|
These instructions assume you have already setup a Knative cluster and installed
|
||||||
cert-manager into your cluster. For more information, see
|
cert-manager into your cluster. For more information, see
|
||||||
[using an SSL certificate](./using-an-ssl-cert.md#install-cert-manager). They also
|
[using an SSL certificate](./using-an-ssl-cert.md#install-cert-manager). They
|
||||||
assume you have already set up your managed zone with Cloud DNS as part of
|
also assume you have already set up your managed zone with Cloud DNS as part of
|
||||||
configuring the domain to map to your IP address.
|
configuring the domain to map to your IP address.
|
||||||
|
|
||||||
To automate the generation of a certificate with cert-manager and LetsEncrypt,
|
To automate the generation of a certificate with cert-manager and LetsEncrypt,
|
||||||
|
|
|
@ -116,9 +116,8 @@ permission to get the credential secret can access your Cloud DNS.
|
||||||
|
|
||||||
## Set up Knative
|
## Set up Knative
|
||||||
|
|
||||||
1. Follow the
|
1. Follow the [instruction](../install/README.md) to install Knative on your
|
||||||
[instruction](../install/README.md)
|
cluster.
|
||||||
to install Knative on your cluster.
|
|
||||||
1. Configure Knative to use your custom domain.
|
1. Configure Knative to use your custom domain.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
|
Loading…
Reference in New Issue