Skip to content
This repository has been archived by the owner on Dec 12, 2023. It is now read-only.

Commit

Permalink
Update Changelog and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Wulf-Thilo Schreiter committed Apr 19, 2020
1 parent e5813b0 commit 2d53860
Show file tree
Hide file tree
Showing 6 changed files with 132 additions and 4 deletions.
44 changes: 43 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,47 @@ All notable changes to this project will be documented in this file.

### Fixed

## [1.3.0]

### Added

* Enable flag to merge answers with exising apps (#42) (#43)
* [FEATURE] global, cluster and project catalogs as code (#39 #44)
* Add Descriptor for Rancher with Catalog client
* Add Descriptor for Cluster with Catalog client
* Add Descriptor for Project with Catalog client
* Add catalog samples
* Add command `list TYPE` to list project resources.
* namespaces
* certificates
* config-maps
* docker-credentials
* secrets
* apps
* jobs
* cron-jobs
* deployments
* daemon-sets
* stateful-sets
* Add command `delete TYPE NAME` to delete project resources.
* namespace
* certificate - NOT YET IMPLEMENTED
* config-map - NOT YET IMPLEMENTED
* docker-credential - NOT YET IMPLEMENTED
* secret - NOT YET IMPLEMENTED
* app
* job
* cron-job - NOT YET IMPLEMENTED
* deployment - NOT YET IMPLEMENTED
* daemon-set - NOT YET IMPLEMENTED
* stateful-set - NOT YET IMPLEMENTED

### Changed

### Removed

### Fixed

## [1.2.0]

### Added
Expand Down Expand Up @@ -73,7 +114,8 @@ All notable changes to this project will be documented in this file.

* Initial release

[Unreleased]: https://github.com/bitgrip/cattlectl/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/bitgrip/cattlectl/compare/v1.3.0...HEAD
[1.3.0]: https://github.com/bitgrip/cattlectl/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/bitgrip/cattlectl/compare/v1.1.1...v1.2.0
[1.1.1]: https://github.com/bitgrip/cattlectl/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/bitgrip/cattlectl/compare/v1.0.0...v1.1.0
2 changes: 1 addition & 1 deletion cmd/delete/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var (
deleteCmd = &cobra.Command{
Use: "delete TYPE NAME",
Short: "Deletes an rancher resouce",
Long: "Deletes an rancher resouce",
Long: deleteLongDescription,
Run: delete,
ValidArgs: validArgs,
}
Expand Down
31 changes: 31 additions & 0 deletions cmd/delete/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Copyright © 2020 Bitgrip <[email protected]>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package delete

var deleteLongDescription = `Deletes an rancher resouce.
### Supported resource types:
* namespace
* certificate - NOT YET IMPLEMENTED
* config-map - NOT YET IMPLEMENTED
* docker-credential - NOT YET IMPLEMENTED
* secret - NOT YET IMPLEMENTED
* app
* job
* cron-job - NOT YET IMPLEMENTED
* deployment - NOT YET IMPLEMENTED
* daemon-set - NOT YET IMPLEMENTED
* stateful-set - NOT YET IMPLEMENTED`
1 change: 1 addition & 0 deletions docs/cattlectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ deployement, if you run cattlectl twice.
* [cattlectl completion](cattlectl_completion.md) - Generates bash completion scripts
* [cattlectl delete](cattlectl_delete.md) - Deletes an rancher resouce
* [cattlectl gen-doc](cattlectl_gen-doc.md) - genrates the markdown documentation
* [cattlectl list](cattlectl_list.md) - Lists an rancher resouce
* [cattlectl show](cattlectl_show.md) - Show the resulting project descriptor
* [cattlectl version](cattlectl_version.md) - version of cattlectl

19 changes: 17 additions & 2 deletions docs/cattlectl_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,21 @@ Deletes an rancher resouce

### Synopsis

Deletes an rancher resouce
Deletes an rancher resouce.

### Supported resource types:

* namespace
* certificate - NOT YET IMPLEMENTED
* config-map - NOT YET IMPLEMENTED
* docker-credential - NOT YET IMPLEMENTED
* secret - NOT YET IMPLEMENTED
* app
* job
* cron-job - NOT YET IMPLEMENTED
* deployment - NOT YET IMPLEMENTED
* daemon-set - NOT YET IMPLEMENTED
* stateful-set - NOT YET IMPLEMENTED

```
cattlectl delete TYPE NAME [flags]
Expand All @@ -14,7 +28,8 @@ cattlectl delete TYPE NAME [flags]

```
-h, --help help for delete
--project-name string The name of the project to delete resouces from
--namespace string The namespace of the project to list resouces from
--project-name string The name of the project to list resouces from
```

### Options inherited from parent commands
Expand Down
39 changes: 39 additions & 0 deletions docs/cattlectl_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## cattlectl list

Lists an rancher resouce

### Synopsis

Lists an rancher resouce

```
cattlectl list TYPE [flags]
```

### Options

```
-h, --help help for list
--namespace string The namespace of the project to list resouces from
--pattern string Match pattern to filter resouce names
--project-name string The name of the project to list resouces from
```

### Options inherited from parent commands

```
--access-key string The access key to access rancher with
--cluster-id string The ID of the cluster the project is part of
--cluster-name string The name of the cluster the project is part of
--config string config file (default is $HOME/.cattlectl.yaml)
--insecure-api If Rancher uses a self signed certificate
--log-json if to log using json format
--rancher-url string The URL to reach the rancher
--secret-key string The secret key to access rancher with
-v, --verbosity int verbosity level to use
```

### SEE ALSO

* [cattlectl](cattlectl.md) - controll your cattle on the ranch

0 comments on commit 2d53860

Please sign in to comment.