这是indexloc提供的服务，不要输入任何密码
Skip to content

Cleanup builder code and docs #5479

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

Merged
merged 2 commits into from
Nov 24, 2022
Merged

Cleanup builder code and docs #5479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beb8dff
docs: cleanup builder docs a little
josegonzalez Nov 24, 2022
7c5b0be
chore: use the correct function when fetching properties with defaults
josegonzalez Nov 24, 2022
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
29 changes: 17 additions & 12 deletions docs/deployment/builders/cloud-native-buildpacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

> New as of 0.22.0

```
builder-pack:report [<app>] [<flag>] # Displays a builder-pack report for one or more apps
builder-pack:set <app> <key> (<value>) # Set or clear a builder-pack property for an app
```

```
buildpacks:set-property [--global|<app>] <key> <value> # Set or clear a buildpacks property for an app
```
Expand Down Expand Up @@ -89,17 +94,17 @@ dokku builder-pack:report

```
=====> node-js-app builder-pack information
Builder-pack computed projecttoml path: project2.toml
Builder-pack global projecttoml path: project.toml
Builder-pack projecttoml path: project2.toml
Builder pack computed projecttoml path: project2.toml
Builder pack global projecttoml path: project.toml
Builder pack projecttoml path: project2.toml
=====> python-sample builder-pack information
Builder-pack computed projecttoml path: project.toml
Builder-pack global projecttoml path: project.toml
Builder-pack projecttoml path:
Builder pack computed projecttoml path: project.toml
Builder pack global projecttoml path: project.toml
Builder pack projecttoml path:
=====> ruby-sample builder-pack information
Builder-pack computed projecttoml path: project.toml
Builder-pack global projecttoml path: project.json
Builder-pack projecttoml path:
Builder pack computed projecttoml path: project.toml
Builder pack global projecttoml path: project.json
Builder pack projecttoml path:
```

You can run the command for a specific app also.
Expand All @@ -110,9 +115,9 @@ dokku builder-pack:report node-js-app

```
=====> node-js-app builder-pack information
Builder-pack computed projecttoml path: project2.toml
Builder-pack global projecttoml path: project.toml
Builder-pack projecttoml path: project2.toml
Builder pack computed projecttoml path: project2.toml
Builder pack global projecttoml path: project.toml
Builder pack projecttoml path: project2.toml
```

You can pass flags which will output only the value of the specific information you want. For example:
Expand Down
29 changes: 17 additions & 12 deletions docs/deployment/builders/dockerfiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

> New as of 0.3.15

```
builder-dockerfile:report [<app>] [<flag>] # Displays a builder-dockerfile report for one or more apps
builder-dockerfile:set <app> <key> (<value>) # Set or clear a builder-dockerfile property for an app
```

While Dokku normally defaults to using [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) for deployment, you can also use Docker's native `Dockerfile` system to define a container.

> Dockerfile support is considered a *power user* feature. By using Dockerfile-based deployment, you agree that you will not have the same comfort as that enjoyed by buildpack users, and Dokku features may work differently. Differences between the two systems will be documented here.
Expand Down Expand Up @@ -67,17 +72,17 @@ dokku builder-dockerfile:report

```
=====> node-js-app builder-dockerfile information
Builder-dockerfile computed dockerfile path: Dockerfile2
Builder-dockerfile global dockerfile path: Dockerfile
Builder-dockerfile dockerfile path: Dockerfile2
Builder dockerfile computed dockerfile path: Dockerfile2
Builder dockerfile global dockerfile path: Dockerfile
Builder dockerfile dockerfile path: Dockerfile2
=====> python-sample builder-dockerfile information
Builder-dockerfile computed dockerfile path: Dockerfile
Builder-dockerfile global dockerfile path: Dockerfile
Builder-dockerfile dockerfile path:
Builder dockerfile computed dockerfile path: Dockerfile
Builder dockerfile global dockerfile path: Dockerfile
Builder dockerfile dockerfile path:
=====> ruby-sample builder-dockerfile information
Builder-dockerfile computed dockerfile path: Dockerfile
Builder-dockerfile global dockerfile path: Dockerfile
Builder-dockerfile dockerfile path:
Builder dockerfile computed dockerfile path: Dockerfile
Builder dockerfile global dockerfile path: Dockerfile
Builder dockerfile dockerfile path:
```

You can run the command for a specific app also.
Expand All @@ -88,9 +93,9 @@ dokku builder-dockerfile:report node-js-app

```
=====> node-js-app builder-dockerfile information
Builder-dockerfile computed dockerfile path: Dockerfile2
Builder-dockerfile global dockerfile path: Dockerfile
Builder-dockerfile dockerfile path: Dockerfile2
Builder dockerfile computed dockerfile path: Dockerfile2
Builder dockerfile global dockerfile path: Dockerfile
Builder dockerfile dockerfile path: Dockerfile2
```

You can pass flags which will output only the value of the specific information you want. For example:
Expand Down
29 changes: 17 additions & 12 deletions docs/deployment/builders/lambda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

> New as of 0.28.0

```
builder-lambda:report [<app>] [<flag>] # Displays a builder-lambda report for one or more apps
builder-lambda:set <app> <key> (<value>) # Set or clear a builder-lambda property for an app
```

The `lambda` builder builds AWS Lambda functions in an environment simulating AWS Lambda runtimes via [lambda-builder](https://github.com/dokku/lambda-builder). Apps built via this builder can run natively in Dokku and may also have their artifacts scheduled to Lambda via an appropriate scheduler.

## Usage
Expand Down Expand Up @@ -70,17 +75,17 @@ dokku builder-lambda:report

```
=====> node-js-app builder-lambda information
Builder-lambda computed lambdayml path: lambda2.yml
Builder-lambda global lambdayml path: lambda.yml
Builder-lambda lambdayml path: lambda2.yml
Builder lambda computed lambdayml path: lambda2.yml
Builder lambda global lambdayml path: lambda.yml
Builder lambda lambdayml path: lambda2.yml
=====> python-sample builder-lambda information
Builder-lambda computed lambdayml path: lambda.yml
Builder-lambda global lambdayml path: lambda.yml
Builder-lambda lambdayml path:
Builder lambda computed lambdayml path: lambda.yml
Builder lambda global lambdayml path: lambda.yml
Builder lambda lambdayml path:
=====> ruby-sample builder-lambda information
Builder-lambda computed lambdayml path: lambda.yml
Builder-lambda global lambdayml path: lambda.yml
Builder-lambda lambdayml path:
Builder lambda computed lambdayml path: lambda.yml
Builder lambda global lambdayml path: lambda.yml
Builder lambda lambdayml path:
```

You can run the command for a specific app also.
Expand All @@ -91,9 +96,9 @@ dokku builder-lambda:report node-js-app

```
=====> node-js-app builder-lambda information
Builder-lambda computed lambdayml path: lambda2.yml
Builder-lambda global lambdayml path: lambda.yml
Builder-lambda lambdayml path: lambda2.yml
Builder lambda computed lambdayml path: lambda2.yml
Builder lambda global lambdayml path: lambda.yml
Builder lambda lambdayml path: lambda2.yml
```

You can pass flags which will output only the value of the specific information you want. For example:
Expand Down
4 changes: 2 additions & 2 deletions plugins/builder-dockerfile/internal-functions
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ fn-builder-dockerfile-computed-dockerfile-path() {
fn-builder-dockerfile-global-dockerfile-path() {
declare APP="$1"

fn-plugin-property-get "builder-dockerfile" "--global" "dockerfile-path" "Dockerfile"
fn-plugin-property-get-default "builder-dockerfile" "--global" "dockerfile-path" "Dockerfile"
}

fn-builder-dockerfile-dockerfile-path() {
declare APP="$1"

fn-plugin-property-get "builder-dockerfile" "$APP" "dockerfile-path" ""
fn-plugin-property-get-default "builder-dockerfile" "$APP" "dockerfile-path" ""
}
4 changes: 2 additions & 2 deletions plugins/builder-lambda/internal-functions
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ fn-builder-lambda-computed-lambdayml-path() {
fn-builder-lambda-global-lambdayml-path() {
declare APP="$1"

fn-plugin-property-get "builder-lambda" "--global" "lambdayml-path" "lambda.yml"
fn-plugin-property-get-default "builder-lambda" "--global" "lambdayml-path" "lambda.yml"
}

fn-builder-lambda-lambdayml-path() {
declare APP="$1"

fn-plugin-property-get "builder-lambda" "$APP" "lambdayml-path" ""
fn-plugin-property-get-default "builder-lambda" "$APP" "lambdayml-path" ""
}
4 changes: 2 additions & 2 deletions plugins/builder-pack/internal-functions
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,11 @@ fn-builder-pack-computed-projecttoml-path() {
fn-builder-pack-global-projecttoml-path() {
declare APP="$1"

fn-plugin-property-get "builder-pack" "--global" "projecttoml-path" "project.toml"
fn-plugin-property-get-default "builder-pack" "--global" "projecttoml-path" "project.toml"
}

fn-builder-pack-projecttoml-path() {
declare APP="$1"

fn-plugin-property-get "builder-pack" "$APP" "projecttoml-path" ""
fn-plugin-property-get-default "builder-pack" "$APP" "projecttoml-path" ""
}