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

Re-generate docs #269

Merged
merged 1 commit into from
Jan 17, 2025
Merged

Re-generate docs #269

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
28 changes: 20 additions & 8 deletions docs/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,15 +284,18 @@ See examples of koyeb service create --help
--checks-grace-period strings Set healthcheck grace period in seconds.
Use the format <healthcheck>=<seconds>, for example --checks-grace-period 8080=10

--config-file strings Mount a copy of local file as a file in the service container using the format LOCAL_FILE:PATH:[PERMISSIONS]
for example --config-file /etc/data.yaml:/etc/data.yaml:0644
To delete a file mount, use !PATH, for example --config-file !/etc/data.yaml

--deployment-strategy STRATEGY Deployment strategy, either "rolling" (default), "blue-green" or "immediate".
--docker string Docker image
--docker-args strings Set arguments to the docker command. To provide multiple arguments, use the --docker-args flag multiple times.
--docker-command string Set the docker CMD explicitly. To provide arguments to the command, use the --docker-args flag.
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
--docker-private-registry-secret string Docker private registry secret
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
To use the value of a secret as an environment variable, use the following syntax:
--env FOO={{secret.bar}}
To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}
To delete an environment variable, prefix its name with '!', for example --env '!FOO'

--git string Git repository
Expand Down Expand Up @@ -577,10 +580,13 @@ koyeb deploy <path> <app>/<service> [flags]
--checks-grace-period strings Set healthcheck grace period in seconds.
Use the format <healthcheck>=<seconds>, for example --checks-grace-period 8080=10

--config-file strings Mount a copy of local file as a file in the service container using the format LOCAL_FILE:PATH:[PERMISSIONS]
for example --config-file /etc/data.yaml:/etc/data.yaml:0644
To delete a file mount, use !PATH, for example --config-file !/etc/data.yaml

--deployment-strategy STRATEGY Deployment strategy, either "rolling" (default), "blue-green" or "immediate".
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
To use the value of a secret as an environment variable, use the following syntax:
--env FOO={{secret.bar}}
To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}
To delete an environment variable, prefix its name with '!', for example --env '!FOO'

-h, --help help for deploy
Expand Down Expand Up @@ -1379,15 +1385,18 @@ $> koyeb service create myservice --app myapp --docker nginx --port 80:tcp
--checks-grace-period strings Set healthcheck grace period in seconds.
Use the format <healthcheck>=<seconds>, for example --checks-grace-period 8080=10

--config-file strings Mount a copy of local file as a file in the service container using the format LOCAL_FILE:PATH:[PERMISSIONS]
for example --config-file /etc/data.yaml:/etc/data.yaml:0644
To delete a file mount, use !PATH, for example --config-file !/etc/data.yaml

--deployment-strategy STRATEGY Deployment strategy, either "rolling" (default), "blue-green" or "immediate".
--docker string Docker image
--docker-args strings Set arguments to the docker command. To provide multiple arguments, use the --docker-args flag multiple times.
--docker-command string Set the docker CMD explicitly. To provide arguments to the command, use the --docker-args flag.
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
--docker-private-registry-secret string Docker private registry secret
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
To use the value of a secret as an environment variable, use the following syntax:
--env FOO={{secret.bar}}
To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}
To delete an environment variable, prefix its name with '!', for example --env '!FOO'

--git string Git repository
Expand Down Expand Up @@ -1833,15 +1842,18 @@ $> koyeb service update myapp/myservice --port 80:tcp --route '!/'
--checks-grace-period strings Set healthcheck grace period in seconds.
Use the format <healthcheck>=<seconds>, for example --checks-grace-period 8080=10

--config-file strings Mount a copy of local file as a file in the service container using the format LOCAL_FILE:PATH:[PERMISSIONS]
for example --config-file /etc/data.yaml:/etc/data.yaml:0644
To delete a file mount, use !PATH, for example --config-file !/etc/data.yaml

--deployment-strategy STRATEGY Deployment strategy, either "rolling" (default), "blue-green" or "immediate".
--docker string Docker image
--docker-args strings Set arguments to the docker command. To provide multiple arguments, use the --docker-args flag multiple times.
--docker-command string Set the docker CMD explicitly. To provide arguments to the command, use the --docker-args flag.
--docker-entrypoint strings Docker entrypoint. To provide multiple arguments, use the --docker-entrypoint flag multiple times.
--docker-private-registry-secret string Docker private registry secret
--env strings Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
To use the value of a secret as an environment variable, use the following syntax:
--env FOO={{secret.bar}}
To use the value of a secret as an environment variable, use the following syntax: --env FOO={{secret.bar}}
To delete an environment variable, prefix its name with '!', for example --env '!FOO'

--git string Git repository
Expand Down
4 changes: 0 additions & 4 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,10 +168,6 @@ github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLf
github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=
github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/koyeb/koyeb-api-client-go v0.0.0-20241206143543-39fbd0d0bf5e h1:/pSEDHiuCglPMooi0kcQay0ZmJ1fZys8qre6Jz2iQ7Q=
github.com/koyeb/koyeb-api-client-go v0.0.0-20241206143543-39fbd0d0bf5e/go.mod h1:+oQfFj2WL3gi9Pb+UHbob4D7xaT52mPfKyH1UvWa4PQ=
github.com/koyeb/koyeb-api-client-go v0.0.0-20250106150959-2940e5613765 h1:OaJezhu0iuR0XN6y5Sxc6uARWyPx1WG1ZjBgVgG7jvw=
github.com/koyeb/koyeb-api-client-go v0.0.0-20250106150959-2940e5613765/go.mod h1:+oQfFj2WL3gi9Pb+UHbob4D7xaT52mPfKyH1UvWa4PQ=
github.com/koyeb/koyeb-api-client-go v0.0.0-20250117143439-03648cc5a823 h1:icM+7zADUhhsv1DSXVHdT3UusXWOsZ25aolFPmhgPiU=
github.com/koyeb/koyeb-api-client-go v0.0.0-20250117143439-03648cc5a823/go.mod h1:+oQfFj2WL3gi9Pb+UHbob4D7xaT52mPfKyH1UvWa4PQ=
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
Expand Down
Loading