github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: use github admonitions

Browse Source 
These still need to be properly parsed.
This commit is contained in:
Jose Diaz-Gonzalez
2023-08-19 14:24:12 -04:00
parent 5dd78e2b86
commit d61d91cf87
47 changed files with 277 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/deployment/builders/builder-management.md
View File

@@ -1,5 +1,6 @@
# Builder Management
> [!IMPORTANT]
> New as of 0.24.0
```
@@ -51,7 +52,8 @@ dokku builder:set --global selected
#### Changing the build directory
> Warning: Please keep in mind that setting a custom build directory will result in loss of any changes to the top-level directory, such as the `git.keep-git-dir` property.
> [!WARNING]
> Please keep in mind that setting a custom build directory will result in loss of any changes to the top-level directory, such as the `git.keep-git-dir` property.
When deploying a monorepo, it may be desirable to specify the specific build directory to use for a given app. This can be done via the `builder:set` command. If a value is specified and that directory does not exist within the repository, the build will fail.

6
docs/deployment/builders/cloud-native-buildpacks.md
View File

@@ -1,5 +1,6 @@
# Cloud Native Buildpacks
> [!IMPORTANT]
> New as of 0.22.0
```
@@ -13,7 +14,8 @@ buildpacks:set-property [--global|<app>] <key> <value> # Set or clear a buildpa
Cloud Native Buildpacks are an evolution over the Buildpacks technology provided by the Herokuish builder. See the [herokuish buildpacks documentation](/docs/deployment/builders/herokuish-buildpacks.md) for more information on how to clear buildpack build cache for an application.
> Warning: This functionality uses the `pack` cli from the [Cloud Native Buildpacks](https://buildpacks.io) project to build apps. As the integration is experimental in Dokku, it is likely to change over time.
> [!WARNING]
> This functionality uses the `pack` cli from the [Cloud Native Buildpacks](https://buildpacks.io) project to build apps. As the integration is experimental in Dokku, it is likely to change over time.
## Usage
@@ -88,6 +90,7 @@ dokku builder-pack:set --global projecttoml-path
### Displaying builder-pack reports for an app
> [!IMPORTANT]
> New as of 0.25.0
You can get a report about the app's storage status using the `builder-pack:report` command:
@@ -136,6 +139,7 @@ project2.toml
### Customizing the Buildpack stack builder
> [!IMPORTANT]
> New as of 0.23.0
The default stack builder in use by CNB buildpacks in Dokku is based on `heroku/builder:22`. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:set-property` command.

3
docs/deployment/builders/dockerfiles.md
View File

@@ -1,5 +1,6 @@
# Dockerfile Deployment
> [!IMPORTANT]
> New as of 0.3.15
```
@@ -64,6 +65,7 @@ dokku builder-dockerfile:set --global dockerfile-path
### Displaying builder-dockerfile reports for an app
> [!IMPORTANT]
> New as of 0.25.0
You can get a report about the app's storage status using the `builder-dockerfile:report` command:
@@ -196,6 +198,7 @@ Setting `$DOKKU_DOCKERFILE_CACHE_BUILD` to `true` or `false` will enable or disa
### Procfiles and multiple processes
> [!IMPORTANT]
> New as of 0.5.0
See the [Procfile documentation](/docs/processes/process-management.md#procfile) for more information on how to specify different processes for your app.

7
docs/deployment/builders/herokuish-buildpacks.md
View File

@@ -1,5 +1,6 @@
# Herokuish Buildpacks
> [!IMPORTANT]
> Subcommands new as of 0.15.0
```
@@ -17,7 +18,8 @@ builder-herokuish:report [<app>] [<flag>] # Displays a builder-herokuish repor
builder-herokuish:set <app> <key> (<value>) # Set or clear a builder-herokuish property for an app
```
> Warning: If using the `buildpacks` plugin, be sure to unset any `BUILDPACK_URL` and remove any such entries from a committed `.env` file. A specified `BUILDPACK_URL` will always override a `.buildpacks` file or the buildpacks plugin.
> [!WARNING]
> If using the `buildpacks` plugin, be sure to unset any `BUILDPACK_URL` and remove any such entries from a committed `.env` file. A specified `BUILDPACK_URL` will always override a `.buildpacks` file or the buildpacks plugin.
Dokku normally defaults to using [Heroku buildpacks](https://devcenter.heroku.com/articles/buildpacks) for deployment, though this may be overridden by committing a valid `Dockerfile` to the root of your repository and pushing the repository to your Dokku installation. To avoid this automatic `Dockerfile` deployment detection, you may do one of the following:
@@ -147,6 +149,7 @@ dokku buildpacks:clear node-js-app
### Customizing the Buildpack stack builder
> [!IMPORTANT]
> New as of 0.23.0
The default stack builder in use by Herokuish buildpacks in Dokku is based on `gliderlabs/herokuish:latest`. Typically, this is installed via an OS package which pulls the requisite Docker image. Users may desire to switch the stack builder to a custom version, either to update the operating system or to customize packages included with the stack builder. This can be performed via the `buildpacks:set-property` command.
@@ -175,6 +178,7 @@ dokku buildpacks:set-property --global stack
### Allowing herokuish for non-amd64 platforms
> [!IMPORTANT]
> New as of 0.29.0
By default, the builder-herokuish plugin is not enabled for non-amd64 platforms, and attempting to use it is blocked. This is because the majority of buildpacks are not cross-platform compatible, and thus building apps will either be considerably slower - due to emulating the amd64 platform - or won't work - due to building amd64 packages on arm/arm64 platforms.
@@ -248,6 +252,7 @@ dokku buildpacks:report node-js-app --buildpacks-list
### Displaying builder-herokuish reports for an app
> [!IMPORTANT]
> New as of 0.29.0
You can get a report about the app's storage status using the `builder-herokuish:report` command:

1
docs/deployment/builders/lambda.md
View File

@@ -1,5 +1,6 @@
# Lambda Builder
> [!IMPORTANT]
> New as of 0.28.0
```

1
docs/deployment/builders/null.md
View File

@@ -1,5 +1,6 @@
# Null Builder
> [!IMPORTANT]
> New as of 0.25.0
The `null` builder does nothing, and is useful for routing to services not managed by Dokku. It should not be used in normal operation. Please see the [network documentation](/docs/networking/network.md#routing-an-app-to-a-known-ip:port-combination) for more information on the aforementioned use case.