Skip to content

Commit 589d135

Browse files
remove markdown sections as they mess up the rendered documentation (#558)
1 parent dbf3606 commit 589d135

2 files changed

Lines changed: 2 additions & 22 deletions

File tree

cmd/kosli/snapshotECS.go

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@ All filtering options are case-sensitive.
2424
The reported data includes cluster and service names, container image digests and creation timestamps.` + awsAuthDesc
2525

2626
const snapshotECSExample = `
27-
###### Authentication to AWS ######
28-
2927
# authentication to AWS using flags
30-
3128
kosli snapshot ecs yourEnvironmentName \
3229
--aws-key-id yourAWSAccessKeyID \
3330
--aws-secret-key yourAWSSecretAccessKey \
@@ -36,7 +33,6 @@ kosli snapshot ecs yourEnvironmentName \
3633
--org yourOrgName
3734
3835
# authentication to AWS using env variables
39-
4036
export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID
4137
export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey
4238
export AWS_REGION=yourAWSRegion
@@ -45,16 +41,11 @@ kosli snapshot ecs yourEnvironmentName \
4541
--api-token yourAPIToken \
4642
--org yourOrgName
4743
48-
###### reporting everything running in all clusters in a given AWS account ######
49-
44+
# reporting everything running in all clusters in a given AWS account
5045
kosli snapshot ecs my-env \
5146
--api-token yourAPIToken \
5247
--org yourOrgName
5348
54-
###### filtering which ECS clusters to snapshot ######
55-
56-
########### including clusters
57-
5849
# include clusters matching a name in the AWS account
5950
kosli snapshot ecs my-env --clusters my-cluster ...
6051
@@ -64,8 +55,6 @@ kosli snapshot ecs my-env --clusters-regex "my-cluster-*" ...
6455
# include clusters matching a list of names in the AWS account
6556
kosli snapshot ecs my-env --clusters my-cluster1,my-cluster2 ...
6657
67-
########### excluding clusters
68-
6958
# exclude clusters matching a name in the AWS account
7059
kosli snapshot ecs my-env --exclude my-cluster ...
7160
@@ -75,12 +64,6 @@ kosli snapshot ecs my-env --exclude-regex "my-cluster-*" ...
7564
# exclude clusters matching a list of names in the AWS account
7665
kosli snapshot ecs my-env --exclude my-cluster1,my-cluster2 ...
7766
78-
79-
80-
###### filtering which ECS services to snapshot ######
81-
82-
########### including services
83-
8467
# include Services matching a name in one cluster
8568
kosli snapshot ecs my-env --clusters my-cluster --services backend-app ...
8669
@@ -96,8 +79,6 @@ kosli snapshot ecs my-env --services backend-app ...
9679
# include Services matching a list of names in all clusters in the AWS account
9780
kosli snapshot ecs my-env --services backend-app,frontend-app ...
9881
99-
########### excluding services
100-
10182
# exclude Services matching a pattern in one cluster
10283
kosli snapshot ecs my-env --clusters my-cluster --exclude-services-regex "backend-*" ...
10384

cmd/kosli/snapshotK8S.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ kosli snapshot k8s yourEnvironmentName \
2727
--api-token yourAPIToken \
2828
--org yourOrgName
2929
30-
# report what is running in an entire cluster using kubeconfig at $HOME/.kube/config
31-
(with global flags defined in environment or in a config file):
30+
# report what is running in an entire cluster using kubeconfig at $HOME/.kube/config (with global flags defined in environment or in a config file):
3231
export KOSLI_API_TOKEN=yourAPIToken
3332
export KOSLI_ORG=yourOrgName
3433

0 commit comments

Comments
 (0)