Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Add dependencies to manifest documentation. Add namespace to last versioned docs. #857

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+78 −24
Open

Add dependencies to manifest documentation. Add namespace to last versioned docs. #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 37 additions & 12 deletions src/content/reference/okteto-manifest.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ Follow this document for a list of [environment variables](reference/okteto-cli.

Use `okteto deploy --dependencies` to force the redeployment of your dependencies.

### dependencies - extended notation (object, optional)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this line. That way everything is index under dependencies

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a good way we can communicate that this property has a simple and an extended notation then? I like the idea of the formatting being consistent but need a way as a consumer to know that there are two explicit versions. (Sidenote, is there a YAML schema for the Okteto file somewhere?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have a YAML schema for the Okteto Manifest yet 😥
Are you familiar with any documentation where they document different field types?
I have been looking for inspiration, but didn't find anything great


There is also an extended notation to configure how to deploy your dependency:

```yaml
Expand All @@ -111,22 +113,45 @@ dependencies:
timeout: 15m
```

Or:
#### repository (string)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would use the same format that we use in the build section. We put the sample first, and then a list of items explaining each field


A reference to a git repository that holds the manifest for your dependency.

#### manifest (string, optional)

A path in the dependency repository that points to an Okteto YAML. When specifying the manifest path, the dependency deployment will use this path where the manifest is defined as the context.

#### branch (string, optional)

The branch to use for your dependency git repository.

#### variables (map[string]string, optional)

Variables to pass to the dependency in string map format.

```yaml
dependencies:
frontend:
repository: https://github.com/okteto/movies-frontend
manifest: okteto.yaml
branch: main
variables:
- ENVIRONMENT: development
- DEBUG: true
wait: true
timeout: 15m
variables:
ENVIRONMENT: development
DEBUG: true
```

#### variables ([string], optional)

Variables to pass to the dependency in a list of strings format.

```yaml
variables:
- ENVIRONMENT: development
- DEBUG: true
```

When specifying the manifest path, the dependency deployment will use this path where the manifest is defined as the context.
#### wait (boolean, optional)

Wait for all resources in the dependency to become healthy before continuing.

#### timeout (string, optional)

Maximum time to be waiting for creating the dependency until an error is returned.

### deploy ([string], optional)

Expand Down
53 changes: 41 additions & 12 deletions versioned_docs/version-1.24/reference/okteto-manifest.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@ Follow this document for a list of [environment variables](reference/okteto-cli.

Use `okteto deploy --dependencies` to force the redeployment of your dependencies.

### dependencies - extended notation (object, optional)

There is also an extended notation to configure how to deploy your dependency:

```yaml
Expand All @@ -127,22 +129,49 @@ dependencies:
timeout: 15m
```

Or:
#### repository (string)

A reference to a git repository that holds the manifest for your dependency.

#### manifest (string, optional)

A path in the dependency repository that points to an Okteto YAML. When specifying the manifest path, the dependency deployment will use this path where the manifest is defined as the context.

#### branch (string, optional)

The branch to use for your dependency git repository.

#### variables (map[string]string, optional)

Variables to pass to the dependency in string map format.

```yaml
dependencies:
frontend:
repository: https://github.com/okteto/movies-frontend
manifest: okteto.yaml
branch: main
variables:
- ENVIRONMENT: development
- DEBUG: true
wait: true
timeout: 15m
variables:
ENVIRONMENT: development
DEBUG: true
```

When specifying the manifest path, the dependency deployment will use this path where the manifest is defined as the context.
#### variables ([string], optional)

Variables to pass to the dependency in a list of strings format.

```yaml
variables:
- ENVIRONMENT: development
- DEBUG: true
```

#### wait (boolean, optional)

Wait for all resources in the dependency to become healthy before continuing.

#### timeout (string, optional)

Maximum time to be waiting for creating the dependency until an error is returned.

#### namespace (string, optional)

The target namespace to deploy the dependency to, if not the current namespace.

### deploy ([string], optional)

Expand Down