Skip to content

Commit 14fceee

Browse files
committed
[docs] update CLI reference with delete command and k8s install --version flag
1 parent 1ef4659 commit 14fceee

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

docs/apoxy.mdx

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Get started at https://apoxy.dev and log in with 'apoxy auth'.
3535
* [apoxy apply](#apoxy-apply) - Apply resources from file(s) or directory
3636
* [apoxy auth](#apoxy-auth) - Authenticate this CLI
3737
* [apoxy backend](#apoxy-backend) - Manage backend objects
38+
* [apoxy delete](#apoxy-delete) - Delete resources by file or type/name
3839
* [apoxy dev](#apoxy-dev) - Develop against the Apoxy API locally
3940
* [apoxy domain](#apoxy-domain) - Manage domain record objects
4041
* [apoxy edgefunction](#apoxy-edgefunction) - Manage edge function objects
@@ -689,6 +690,77 @@ apoxy backend list [flags]
689690

690691

691692

693+
## apoxy delete
694+
695+
Delete resources by file or type/name
696+
697+
### Synopsis
698+
699+
Delete resources identified in file(s), directories, stdin, or by type and name.
700+
701+
Supports two modes:
702+
1. File-based: delete resources specified in YAML/JSON files, directories, or stdin.
703+
2. Type+name: delete one or more resources by specifying the resource type and name(s).
704+
705+
When a directory is specified with -f, all .yaml, .yml, and .json files are processed.
706+
707+
Examples:
708+
# Delete resources in a single file
709+
apoxy delete -f gateway.yaml
710+
711+
# Delete resources in multiple files
712+
apoxy delete -f gateway.yaml -f routes.yaml
713+
714+
# Delete all resources in a directory
715+
apoxy delete -f ./manifests/
716+
717+
# Delete from stdin
718+
cat manifest.yaml | apoxy delete -f -
719+
720+
# Delete a resource by type and name
721+
apoxy delete proxy my-proxy
722+
723+
# Delete multiple resources by type and name
724+
apoxy delete backend backend-a backend-b
725+
726+
# Delete a resource, ignoring if it doesn't exist
727+
apoxy delete proxy my-proxy --ignore-not-found
728+
729+
# Delete and wait for the resource to be fully removed
730+
apoxy delete proxy my-proxy --wait
731+
732+
```
733+
apoxy delete (-f <filename> | <type> <name> [<name>...]) [flags]
734+
```
735+
736+
### Options
737+
738+
```
739+
-f, --filename stringArray Files or directories containing resources to delete (can be specified multiple times)
740+
-h, --help help for delete
741+
--ignore-not-found Treat "resource not found" as a successful delete
742+
-R, --recursive Process directories recursively
743+
--timeout duration Timeout for --wait (e.g. 30s, 2m) (default 1m0s)
744+
--wait Wait for the resource to be fully deleted before returning
745+
```
746+
747+
### Options inherited from parent commands
748+
749+
```
750+
--alsologtostderr Log to standard error as well as files.
751+
--config string Config file (default is $HOME/.apoxy/config.yaml).
752+
--local Run in local mode.
753+
--pprof Enable pprof HTTP server on :6060.
754+
--project string The project ID to use.
755+
-v, --verbose Enable verbose output.
756+
```
757+
758+
### SEE ALSO
759+
760+
* [apoxy](#apoxy) - Open-source edge platform built on Envoy, Kubernetes APIs, and QUIC tunneling.
761+
762+
763+
692764
## apoxy dev
693765

694766
Develop against the Apoxy API locally
@@ -1882,6 +1954,7 @@ apoxy k8s install [flags]
18821954
--kubeconfig string Path to the kubeconfig file to use for Kubernetes API access
18831955
--mirror string Mirror mode (gateway, ingress, all)
18841956
--namespace string The namespace to install the controller into (default "apoxy")
1957+
--version string Controller version override (e.g. v0.3.0)
18851958
-y, --yes Skip confirmation and apply changes immediately
18861959
```
18871960

0 commit comments

Comments
 (0)