Compare commits
2 Commits
main
...
feature/se
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98dcf5d967 | ||
|
|
9b91213bf8 |
80
docs/cli.md
80
docs/cli.md
@ -68,7 +68,7 @@ $ laconic-so build-npms --include <package-name> --force-rebuild
|
|||||||
|
|
||||||
## deploy
|
## deploy
|
||||||
|
|
||||||
The `deploy` command group manages persistent deployments. The general workflow is `deploy init` to generate a spec file, then `deploy create` to create a deployment directory from the spec, then runtime commands like `deploy up` and `deploy down`.
|
The `deploy` command group manages persistent deployments. The general workflow is `deploy init` to generate a spec file, then `deploy create` to create a deployment directory from the spec, then runtime commands like `deployment start` and `deployment stop`.
|
||||||
|
|
||||||
### deploy init
|
### deploy init
|
||||||
|
|
||||||
@ -101,35 +101,91 @@ Options:
|
|||||||
- `--spec-file` (required): spec file to use
|
- `--spec-file` (required): spec file to use
|
||||||
- `--deployment-dir`: target directory for deployment files
|
- `--deployment-dir`: target directory for deployment files
|
||||||
- `--update`: update an existing deployment directory, preserving data volumes and env file. Changed files are backed up with a `.bak` suffix. The deployment's `config.env` and `deployment.yml` are also preserved.
|
- `--update`: update an existing deployment directory, preserving data volumes and env file. Changed files are backed up with a `.bak` suffix. The deployment's `config.env` and `deployment.yml` are also preserved.
|
||||||
|
- `--helm-chart`: generate Helm chart instead of deploying (k8s only)
|
||||||
- `--network-dir`: network configuration supplied in this directory
|
- `--network-dir`: network configuration supplied in this directory
|
||||||
- `--initial-peers`: initial set of persistent peers
|
- `--initial-peers`: initial set of persistent peers
|
||||||
|
|
||||||
### deploy up
|
## deployment
|
||||||
|
|
||||||
Start a deployment:
|
Runtime commands for managing a created deployment. Use `--dir` to specify the deployment directory.
|
||||||
|
|
||||||
|
### deployment start
|
||||||
|
|
||||||
|
Start a deployment (`up` is a legacy alias):
|
||||||
```
|
```
|
||||||
$ laconic-so deployment --dir <deployment-dir> up
|
$ laconic-so deployment --dir <deployment-dir> start
|
||||||
```
|
```
|
||||||
|
|
||||||
### deploy down
|
Options:
|
||||||
|
- `--stay-attached` / `--detatch-terminal`: attach to container stdout (default: detach)
|
||||||
|
- `--skip-cluster-management` / `--perform-cluster-management`: skip kind cluster creation/teardown (default: perform management). Only affects k8s-kind deployments. Use this when multiple stacks share a single cluster.
|
||||||
|
|
||||||
Stop a deployment:
|
### deployment stop
|
||||||
```
|
|
||||||
$ laconic-so deployment --dir <deployment-dir> down
|
|
||||||
```
|
|
||||||
Use `--delete-volumes` to also remove data volumes.
|
|
||||||
|
|
||||||
### deploy ps
|
Stop a deployment (`down` is a legacy alias):
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> stop
|
||||||
|
```
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- `--delete-volumes` / `--preserve-volumes`: delete data volumes on stop (default: preserve)
|
||||||
|
- `--skip-cluster-management` / `--perform-cluster-management`: skip kind cluster teardown (default: perform management). Use this to stop a single deployment without destroying a shared cluster.
|
||||||
|
|
||||||
|
### deployment restart
|
||||||
|
|
||||||
|
Restart a deployment with GitOps-aware workflow. Pulls latest stack code, syncs the deployment directory from the git-tracked spec, and restarts services:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> restart
|
||||||
|
```
|
||||||
|
|
||||||
|
See [deployment_patterns.md](deployment_patterns.md) for the recommended GitOps workflow.
|
||||||
|
|
||||||
|
### deployment ps
|
||||||
|
|
||||||
Show running services:
|
Show running services:
|
||||||
```
|
```
|
||||||
$ laconic-so deployment --dir <deployment-dir> ps
|
$ laconic-so deployment --dir <deployment-dir> ps
|
||||||
```
|
```
|
||||||
|
|
||||||
### deploy logs
|
### deployment logs
|
||||||
|
|
||||||
View service logs:
|
View service logs:
|
||||||
```
|
```
|
||||||
$ laconic-so deployment --dir <deployment-dir> logs
|
$ laconic-so deployment --dir <deployment-dir> logs
|
||||||
```
|
```
|
||||||
Use `-f` to follow and `-n <count>` to tail.
|
Use `-f` to follow and `-n <count>` to tail.
|
||||||
|
|
||||||
|
### deployment exec
|
||||||
|
|
||||||
|
Execute a command in a running service container:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> exec <service-name> "<command>"
|
||||||
|
```
|
||||||
|
|
||||||
|
### deployment status
|
||||||
|
|
||||||
|
Show deployment status:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> status
|
||||||
|
```
|
||||||
|
|
||||||
|
### deployment port
|
||||||
|
|
||||||
|
Show mapped ports for a service:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> port <service-name> <port>
|
||||||
|
```
|
||||||
|
|
||||||
|
### deployment push-images
|
||||||
|
|
||||||
|
Push deployment images to a registry:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> push-images
|
||||||
|
```
|
||||||
|
|
||||||
|
### deployment run-job
|
||||||
|
|
||||||
|
Run a one-time job in the deployment:
|
||||||
|
```
|
||||||
|
$ laconic-so deployment --dir <deployment-dir> run-job <job-name>
|
||||||
|
```
|
||||||
|
|||||||
@ -30,7 +30,7 @@ git commit -m "Add my-stack deployment configuration"
|
|||||||
git push
|
git push
|
||||||
|
|
||||||
# On deployment server: deploy from git-tracked spec
|
# On deployment server: deploy from git-tracked spec
|
||||||
laconic-so deploy create \
|
laconic-so --stack my-stack deploy create \
|
||||||
--spec-file /path/to/operator-repo/spec.yml \
|
--spec-file /path/to/operator-repo/spec.yml \
|
||||||
--deployment-dir my-deployment
|
--deployment-dir my-deployment
|
||||||
|
|
||||||
|
|||||||
@ -29,6 +29,7 @@ network_key = "network"
|
|||||||
http_proxy_key = "http-proxy"
|
http_proxy_key = "http-proxy"
|
||||||
image_registry_key = "image-registry"
|
image_registry_key = "image-registry"
|
||||||
configmaps_key = "configmaps"
|
configmaps_key = "configmaps"
|
||||||
|
secrets_key = "secrets"
|
||||||
resources_key = "resources"
|
resources_key = "resources"
|
||||||
volumes_key = "volumes"
|
volumes_key = "volumes"
|
||||||
security_key = "security"
|
security_key = "security"
|
||||||
|
|||||||
@ -477,6 +477,9 @@ def init_operation(
|
|||||||
spec_file_content["volumes"] = {**volume_descriptors, **orig_volumes}
|
spec_file_content["volumes"] = {**volume_descriptors, **orig_volumes}
|
||||||
if configmap_descriptors:
|
if configmap_descriptors:
|
||||||
spec_file_content["configmaps"] = configmap_descriptors
|
spec_file_content["configmaps"] = configmap_descriptors
|
||||||
|
if "k8s" in deployer_type:
|
||||||
|
if "secrets" not in spec_file_content:
|
||||||
|
spec_file_content["secrets"] = {}
|
||||||
|
|
||||||
if opts.o.debug:
|
if opts.o.debug:
|
||||||
print(
|
print(
|
||||||
|
|||||||
@ -483,6 +483,16 @@ class ClusterInfo:
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
]
|
]
|
||||||
|
# Mount user-declared secrets from spec.yml
|
||||||
|
for user_secret_name in self.spec.get_secrets():
|
||||||
|
env_from.append(
|
||||||
|
client.V1EnvFromSource(
|
||||||
|
secret_ref=client.V1SecretEnvSource(
|
||||||
|
name=user_secret_name,
|
||||||
|
optional=True,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
container = client.V1Container(
|
container = client.V1Container(
|
||||||
name=container_name,
|
name=container_name,
|
||||||
image=image_to_use,
|
image=image_to_use,
|
||||||
|
|||||||
@ -115,6 +115,9 @@ class Spec:
|
|||||||
def get_configmaps(self):
|
def get_configmaps(self):
|
||||||
return self.obj.get(constants.configmaps_key, {})
|
return self.obj.get(constants.configmaps_key, {})
|
||||||
|
|
||||||
|
def get_secrets(self):
|
||||||
|
return self.obj.get(constants.secrets_key, {})
|
||||||
|
|
||||||
def get_container_resources(self):
|
def get_container_resources(self):
|
||||||
return Resources(
|
return Resources(
|
||||||
self.obj.get(constants.resources_key, {}).get("containers", {})
|
self.obj.get(constants.resources_key, {}).get("containers", {})
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user