Skip to content

Commit

Permalink
fix links to devfile 2.2.0 spec (#6616)
Browse files Browse the repository at this point in the history
  • Loading branch information
kadel authored Feb 22, 2023
1 parent e60a502 commit 6b9c6a9
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/website/docs/command-reference/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The kind `deploy` is supported by the devfile format starting from version 2.2.0

The `deploy` command is typically a *composite* command, composed of several *apply* commands:
- a command referencing an `image` component that, when applied, will build the image of the container to deploy, and push it to its registry,
- a command referencing a [`kubernetes` component](https://devfile.io/docs/2.2.0-alpha/defining-kubernetes-resources) that, when applied, will create a Kubernetes resource in the cluster.
- a command referencing a [`kubernetes` component](https://devfile.io/docs/2.2.0/defining-kubernetes-resources) that, when applied, will create a Kubernetes resource in the cluster.

With the following example `devfile.yaml` file, a container image will be built by using the `Dockerfile` present in the directory,
the image will be pushed to its registry and a Kubernetes Deployment will be created in the cluster, using this freshly built image.
Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/command-reference/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ These instructions make up the development cycle of `odo dev`.

With the following example `devfile.yaml` file generated by `odo init` and selecting `nodejs`, a container image will be pushed to the cluster, as well as your source code in order to start the development inner loop cycle.

A much more descriptive explanation on each part of a Devfile can be found on the [Devfile API reference](https://devfile.io/docs/2.2.0-alpha/devfile-schema) site.
A much more descriptive explanation on each part of a Devfile can be found on the [Devfile API reference](https://devfile.io/docs/2.2.0/devfile-schema) site.

Below, we'll explain each section of the corresponding Devfile:

Expand Down
4 changes: 2 additions & 2 deletions docs/website/docs/development/architecture/how-odo-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ Additionally, the following environment variables are reserved and injected into

| Key | Description | Example Value |
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|
| `PROJECTS_ROOT` | A path where the project sources are mounted as defined by container component's [`sourceMapping`](https://devfile.io/docs/2.2.0-alpha/devfile-schema#components-container-source-mapping). Default value is `/projects`. | `/projects` |
| `PROJECTS_ROOT` | A path where the project sources are mounted as defined by container component's [`sourceMapping`](https://devfile.io/docs/2.2.0/devfile-schema#components-container-source-mapping). Default value is `/projects`. | `/projects` |
| `PROJECT_SOURCE` | A path to a project source (`$PROJECTS_ROOT/`). If there are multiple projects, this will point to the directory of the first one. Default value is `/projects`. | `/projects` |


Expand Down Expand Up @@ -625,7 +625,7 @@ spec:

##### Devfile Volume Components

The [Devfile specification](https://devfile.io/docs/2.2.0-alpha/adding-a-volume-component) allows to define `volume` components to share files among container components.
The [Devfile specification](https://devfile.io/docs/2.2.0/adding-a-volume-component) allows to define `volume` components to share files among container components.
Such `volume` components can be marked as `ephemeral` or not.
- If `ephemeral` is set to `false`, which is the default value, `odo` creates a [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) (PVC) (with the default storage class).
- If `ephemeral` is set to `true`, `odo` translates it into an [`emptyDir`](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume, tied to the lifetime of the Pod.
Expand Down
8 changes: 4 additions & 4 deletions docs/website/docs/development/devfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 30

### Overview

We use the latest [Devfile 2.2.0 reference](https://devfile.io/docs/2.2.0-alpha/devfile-schema) in `odo`.
We use the latest [Devfile 2.2.0 reference](https://devfile.io/docs/2.2.0/devfile-schema) in `odo`.

Below are `odo`-specific examples regarding the Devfile reference. Everything we have listed below is implemented in the current version of `odo`.

Expand Down Expand Up @@ -98,7 +98,7 @@ We use practical approach outlining the details of Devfile. The example is a mod

In this example, we are deploying a full Node.js application that is available through both `odo dev` and `odo deploy`.

For a more in-depth detailed outline of Devfile, please refer to the official [Devfile 2.2.0 reference](https://devfile.io/docs/2.2.0-alpha/devfile-schema).
For a more in-depth detailed outline of Devfile, please refer to the official [Devfile 2.2.0 reference](https://devfile.io/docs/2.2.0/devfile-schema).

**NOTE:** Some portions of the Devfile examples are commented out to show what is *available* but it does not apply to the practical example.

Expand Down Expand Up @@ -686,7 +686,7 @@ components:
### Not Yet Implemented
All full descriptions of missing specification features can be found on the [2.2.0 API Specification](https://devfile.io/docs/2.2.0-alpha/devfile-schema).
All full descriptions of missing specification features can be found on the [2.2.0 API Specification](https://devfile.io/docs/2.2.0/devfile-schema).
List of Devfile spec features not yet implemented in `odo`:

Expand Down Expand Up @@ -737,7 +737,7 @@ components:
- name: outerloop-deployment
kubernetes:
# NOT YET IMPLEMENTED
# See: https://devfile.io/docs/2.2.0-alpha/devfile-schema
# See: https://devfile.io/docs/2.2.0/devfile-schema
# for full details
# endpoints:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The kind `deploy` is supported by the devfile format starting from version 2.2.0

The `deploy` command is typically a *composite* command, composed of several *apply* commands:
- a command referencing an `image` component that, when applied, will build the image of the container to deploy, and push it to its registry,
- a command referencing a [`kubernetes` component](https://devfile.io/docs/2.2.0-alpha/defining-kubernetes-resources) that, when applied, will create a Kubernetes resource in the cluster.
- a command referencing a [`kubernetes` component](https://devfile.io/docs/2.2.0/defining-kubernetes-resources) that, when applied, will create a Kubernetes resource in the cluster.

With the following example `devfile.yaml` file, a container image will be built by using the `Dockerfile` present in the directory,
the image will be pushed to its registry and a Kubernetes Deployment will be created in the cluster, using this freshly built image.
Expand Down

0 comments on commit 6b9c6a9

Please sign in to comment.