Skip to content
This repository has been archived by the owner on Nov 22, 2024. It is now read-only.

Commit

Permalink
Remove the old Cli (#914)
Browse files Browse the repository at this point in the history
* Remove the old Cli

* Remove CI for the Cli
  • Loading branch information
andreaTP authored Dec 10, 2020
1 parent 6eb79dc commit 810b5d3
Show file tree
Hide file tree
Showing 55 changed files with 119 additions and 6,844 deletions.
36 changes: 0 additions & 36 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,42 +43,6 @@ jobs:
cd scripts
./build-all.sh +test
build-and-test-cli:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2

- name: Set up Go
uses: actions/[email protected]
with:
go-version: 1.14.2
id: go

- uses: actions/cache@v1
with:
path: ~/go/pkg/mod
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-go-
- name: Check code format
run: |
cd kubectl-cloudflow
if [[ $(go fmt ./...) ]]; then
echo "go fmt check failed"
exit 1
else
echo "go fmt check success"
fi
- name: Build
run: |
set -e
cd kubectl-cloudflow
make test
build-and-test-integration-tests:
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ get-version:
# get latest tag
$(eval version=$(shell sh -c "git for-each-ref refs/tags --sort=-taggerdate --format='%(refname)' --count=1 | sed 's|refs/tags/v||'"))
# query bintray for the corresponding artifact version
$(eval bintray_version=$(shell sh -c "wget -qO - https://api.bintray.com/packages/lightbend/cloudflow-cli/kubectl-cloudflow | jq -r '.versions[] | select( . | startswith(\"${version}.\") )'"))
$(eval bintray_version=$(shell sh -c "wget -qO - https://api.bintray.com/packages/lightbend/cloudflow-cli/kubectl-cloudflow2 | jq -r '.versions[] | select( . | startswith(\"cloudflow_v${version}\") )'"))

set-antora-versions: get-version
yq write shared-content-source/docs/base-antora.yml version "${version}" > shared-content-source/docs/antora.yml
Expand Down
8 changes: 0 additions & 8 deletions docs/docs-source/docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ include::partial$include.adoc[]
** xref:develop:cloudflow-local-sandbox.adoc[Running in the Local Sandbox]
* xref:cli:cloudflow.adoc[kubectl cloudflow - cli commands]
** xref:cli:cloudflow_configure.adoc[configure]
** xref:cli:cloudflow_deploy.adoc[deploy]
** xref:cli:cloudflow_list.adoc[list]
** xref:cli:cloudflow_scale.adoc[scale]
** xref:cli:cloudflow_status.adoc[status]
** xref:cli:cloudflow_undeploy.adoc[undeploy]
** xref:cli:cloudflow_update-docker-credentials.adoc[update-docker-credentials]
** xref:cli:cloudflow_version.adoc[version]
* xref:administration:index.adoc[Installing and configuring components]
** xref:administration:installation-prerequisites.adoc[Installation Prerequisites]
Expand Down
132 changes: 115 additions & 17 deletions docs/docs-source/docs/modules/cli/pages/cloudflow.adoc
Original file line number Diff line number Diff line change
@@ -1,26 +1,124 @@
= cloudflow
:toc:
:toc-title: ON THIS PAGE
:toclevels: 2
= kubectl-cloudflow
== Usage:
[source,bash]
----
kubectl-cloudflow [ version | list | status | deploy | undeploy | update-docker-credentials | scale | configure ] [options] <args>...
----

* `` -v, --log-level <value> ``the logging level
* `` --kube-config <value> ``the kubernetes configuration file
* `` --help ``prints this usage text



== Command: version
[source,bash]
----
version [options]
----

=== Synopsis
show the current version

* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: list
[source,bash]
----
list [options]
----

=== Synopsis
list available cloudflow applications

* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: status
[source,bash]
----
status [options] <cloudflowApp>
----

=== Synopsis
show the status of a cloudflow application

Create, manage, deploy, and operate Cloudflow applications.
* `` <cloudflowApp> ``the name of the cloudflow application
* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: deploy
[source,bash]
----
deploy [options] <crFile> [config-key]
----

=== Synopsis
deploy a cloudflow applications from a cr file

* `` --help ``detailed deploy command help
* `` <crFile> ``the CR file of the cloudflow application
* `` -u, --username <value> ``the docker registry username
* `` -p, --password <value> ``the docker registry password
* `` --password-stdin ``Take the docker registry password from std-in
* `` --no-registry-credentials
``No need for registry credentials (e.g. already in the cluster)
* `` --volume-mount <value> ``Key/value pairs of the volume mounts
* `` --scale <value> ``Key/value pairs of streamlets replicas
* `` --conf <value> ``the configuration file/s in HOCON format
* `` config-key ``the configuration keys for the overrides
* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: undeploy
[source,bash]
----
undeploy [options] <cloudflowApp>
----

=== Synopsis
undeploy a cloudflow application

* `` <cloudflowApp> ``the name of the cloudflow application
* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: update-docker-credentials
[source,bash]
----
update-docker-credentials [options] <cloudflowApp> <dockerRegistry>
----

=== Synopsis
updates docker registry credentials that are used to pull Cloudflow application images.

* `` <cloudflowApp> ``the name of the cloudflow application
* `` <dockerRegistry> ``the name of the docker registry
* `` -u, --username <value> ``the docker registry username
* `` -p, --password <value> ``the docker registry password
* `` --password-stdin ``Take the docker registry password from std-in
* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: scale
[source,bash]
----
scale [options] <cloudflowApp> [<streamlet>=<replicas>]
----

== Synopsis
=== Synopsis
scales a streamlet of a deployed Cloudflow application to the specified number of replicas

This command line tool can be used to deploy and operate Cloudflow applications.
* `` <cloudflowApp> ``the cloudflow application
* `` <streamlet>=<replicas> ``Key/value pairs of streamlets replicas
* `` -o, --output <value> ``available options are: c or classic, t or table, json

== Command: configure
[source,bash]
----
-h, --help help for cloudflow
configure [options] <cloudflowApp> [config-key]
----

== SEE ALSO
=== Synopsis
configures a deployed cloudflow application

* <<cloudflow_configure.adoc#,kubectl cloudflow configure>> - Configures a deployed Cloudflow application.
* <<cloudflow_deploy.adoc#,kubectl cloudflow deploy>> - Deploys a Cloudflow application to the cluster.
* <<cloudflow_list.adoc#,kubectl cloudflow list>> - Lists deployed Cloudflow application in the current cluster.
* <<cloudflow_scale.adoc#,kubectl cloudflow scale>> - Scales a streamlet of a deployed Cloudflow application to the specified number of replicas.
* <<cloudflow_status.adoc#,kubectl cloudflow status>> - Gets the status of a Cloudflow application.
* <<cloudflow_undeploy.adoc#,kubectl cloudflow undeploy>> - Undeploys a Cloudflow application.
* <<cloudflow_update-docker-credentials.adoc#,kubectl cloudflow update-docker-credentials>> - Updates docker registry credentials that are used to pull Cloudflow application images.
* <<cloudflow_version.adoc#,kubectl cloudflow version>> - Prints the plugin version.
* `` --help ``detailed configure command help
* `` <cloudflowApp> ``the cloudflow application
* `` --conf <value> ``the configuration file/s in HOCON format
* `` config-key ``the configuration keys for the overrides
* `` -o, --output <value> ``available options are: c or classic, t or table, json
86 changes: 0 additions & 86 deletions docs/docs-source/docs/modules/cli/pages/cloudflow_configure.adoc

This file was deleted.

Loading

0 comments on commit 810b5d3

Please sign in to comment.