Skip to content

Commit

Permalink
s/Loodse/Kubermatic/g, general cleanup (#103)
Browse files Browse the repository at this point in the history
* rename Loodse to Kubermatic, update CoC

* remove ex employees from owners list

* tidy up readme a bit

* fix boilerplates

* fix lint issues

* align efficiency claims
  • Loading branch information
xrstf authored Jan 28, 2025
1 parent 6abf81a commit b898b97
Show file tree
Hide file tree
Showing 17 changed files with 75 additions and 94 deletions.
29 changes: 17 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# How to Contribute

Loodse projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
GitHub pull requests. This document outlines some of the conventions on
Kubermatic projects are [Apache 2.0 licensed](LICENSE) and accept contributions
via GitHub pull requests. This document outlines some of the conventions on
development workflow, commit message formatting, contact points and other
resources to make it easier to get your contribution accepted.

Expand All @@ -12,7 +12,8 @@ Origin (DCO). This document was created by the Linux Kernel community and is a
simple statement that you, as a contributor, have the legal right to make the
contribution. See the [DCO](DCO) file for details.

Any copyright notices in this repo should specify the authors as "the Loodse XXX project contributors".
Any copyright notices in this repo should specify the authors as "The Kubermatic
fubectl Authors".

To sign your work, just add a line like this at the end of your commit message:

Expand All @@ -22,26 +23,30 @@ Signed-off-by: Joe Example <[email protected]>

This can easily be done with the `--signoff` option to `git commit`.

Note that we're requiring all commits in a PR to be signed-off. If you already created a PR, you can sign-off all existing commits by rebasing with the `--signoff` flag.
Note that we're requiring all commits in a PR to be signed-off. If you already
created a PR, you can sign-off all existing commits by rebasing with the
`--signoff` flag.

```
git rebase --signoff origin/master
```

By doing this you state that you can certify the following (from https://developercertificate.org/):
By doing this you state that you can certify the following
(from https://developercertificate.org/):

## Email and Chat
## Chat

The XXX project currently uses the general Loodse email list and Slack channel:
- Email: [loodse-dev](https://groups.google.com/forum/#!forum/loodse-dev)
- Slack: #[Slack](http://slack.kubermatic.io/) on Slack
The fubectl project currently uses the general Kubermatic Slack channel:

Please avoid emailing maintainers found in the MAINTAINERS file directly. They
are very busy and read the mailing lists.
- Slack: #[Slack](http://slack.kubermatic.io/) on Slack

## Reporting a security vulnerability

Due to their public nature, GitHub and mailing lists are not appropriate places for reporting vulnerabilities. If you suspect you have found a security vulnerability, please do not file a GitHub issue, but instead email [email protected] with the full details, including steps to reproduce the issue.
Due to their public nature, GitHub and mailing lists are not appropriate places
for reporting vulnerabilities. If you suspect you have found a security
vulnerability, please do not file a GitHub issue, but instead email
[email protected] with the full details, including steps to reproduce the
issue.

## Getting Started

Expand Down
8 changes: 4 additions & 4 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Loodse Project
Copyright 2019 Loodse GmbH
fubectl
Copyright 2019 Kubermatic GmbH

This product includes software developed at Loodse GmbH.
(http://www.loodse.com/).
This product includes software developed at Kubermatic GmbH.
(http://www.kubermatic.com/).
4 changes: 0 additions & 4 deletions OWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

approvers:
- toschneck
- thz
- eqrx
- scheeles
- xrstf
- kron4eg

reviewers:
- toschneck
- thz
- eqrx
- scheeles
- xrstf
- kron4eg
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Because it's fancy-kubectl !

## Installation

You can directly download the [`fubectl.source`](https://rawgit.com/kubermatic/fubectl/master/fubectl.source)
You can directly download the [`fubectl.source`](https://rawgit.com/kubermatic/fubectl/main/fubectl.source)
and save it in some directory.

Download:
```bash
curl -LO https://rawgit.com/kubermatic/fubectl/master/fubectl.source
curl -LO https://rawgit.com/kubermatic/fubectl/main/fubectl.source
```

then add to your .bashrc/.zshrc file:
Expand All @@ -28,9 +28,9 @@ choice.

## What can it do?

### k - alias for kubectl
### `k` alias for kubectl

Like g for git but 133% more effective!
Like g for git but 233% more effective!

Examples:
- `k get nodes`
Expand All @@ -42,8 +42,7 @@ Usage:

---

### kw - alias for 'watch kubectl'

### `kw` – alias for 'watch kubectl'

Examples:
- `kw nodes`
Expand All @@ -52,7 +51,7 @@ Examples:

---

### kall - All pods in all namespaces
### `kall` All pods in all namespaces

Get all pods

Expand All @@ -61,7 +60,7 @@ Usage:

---

### kwall - Watch all pods in all namespaces
### `kwall` Watch all pods in all namespaces

Watch all pods in all namespaces every 2 seconds.

Expand All @@ -70,7 +69,7 @@ Usage:

---

### kdes - Describe a resource
### `kdes` Describe a resource

Examples:
- `kdes pod`
Expand All @@ -82,7 +81,7 @@ Usage:

---

### kdel - Delete a resource
### `kdel` Delete a resource

Examples:
- `kdel pod`
Expand All @@ -94,7 +93,7 @@ Usage:

---

### klog - Print the logs for a container in a pod
### `klog` Print the logs for a container in a pod

Examples:
- `klog` - Print the last 10 lines
Expand All @@ -107,7 +106,7 @@ Usage:

---

### kex - Execute a command in a container
### `kex` Execute a command in a container

Examples:
- `kex bash` - Start a bash in a container
Expand All @@ -118,7 +117,7 @@ Usage:

---

### kfor - Forward one or more local ports to a pod
### `kfor` Forward one or more local ports to a pod

Examples:
- `kfor 8000` - Forwards port 8000 to a pod
Expand All @@ -129,7 +128,7 @@ Usage:

---

### ksearch - Search for string in resources
### `ksearch` Search for string in resources

Examples:
- `// TODO`
Expand All @@ -139,20 +138,23 @@ Usage:

---

### kcl - Displays one or many contexts from the kubeconfig file
### `kcl` – Displays one or many contexts from the kubeconfig file

Context list

Usage:
![kGif](./demo_src/kcl.gif)

---
### kcs - Sets the current context

### `kcs` – Sets the current context

Usage:
![kGif](./demo_src/kcs.gif)

---

### kcns - Switch the default namespace
### `kcns` Switch the default namespace

`kcns` - Set the current default namespace from list
`kcns kube-system` - Set kube-system as default namespace immediately
Expand All @@ -161,20 +163,21 @@ Usage:
![kGif](./demo_src/kcns.gif)
---

### kdebug - Start a debugging Pod in a Cluster
### `kdebug` Start a debugging Pod in a Cluster

Usage:
![kGif](./demo_src/kdebug.gif)

---

### kp - Open the Kubernetes dashboard
### `kp` Open the Kubernetes dashboard

Opens `localhost:8001/ui` in your browser and runs `kubectl proxy`

---

## Extra!

Do you want to have the current kubecontext in your prompt?:
```bash
export PS1="\[$(kube_ctx_name)\] $PS1"
Expand All @@ -189,8 +192,8 @@ export PS1="\[$(kube_ctx_namespace)\] $PS1"

`fubectl` can be customized via following environment variables

* `FUBECTL_WATCH_CMD` - alterative `watch` command, e.g. [viddy](https://github.com/sachaos/viddy)
* `FUBECTL_NO_KCL` - disable `kcl` alias, since it may conflict with [KCL language CLI](https://www.kcl-lang.io/)
* `FUBECTL_WATCH_CMD` alterative `watch` command, e.g. [viddy](https://github.com/sachaos/viddy)
* `FUBECTL_NO_KCL` disable `kcl` alias, since it may conflict with [KCL language CLI](https://www.kcl-lang.io/)

## Troubleshooting

Expand All @@ -212,8 +215,8 @@ Feedback and discussion are available on [Kubermatic Slack][15].
* We welcome pull requests. Feel free to dig through the [issues][1] and jump in.

[1]: https://github.com/kubermatic/fubectl/issues
[2]: https://github.com/kubermatic/fubectl/blob/master/CONTRIBUTING.md
[4]: https://github.com/kubermatic/fubectl/blob/master/CODE_OF_CONDUCT.md
[2]: https://github.com/kubermatic/fubectl/blob/main/CONTRIBUTING.md
[4]: https://github.com/kubermatic/fubectl/blob/main/code-of-conduct.md

[12]: https://kubermatic.slack.com/messages/fubectl
[15]: http://slack.kubermatic.io/
4 changes: 2 additions & 2 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Loodse Community Code of Conduct
# Kubermatic Community Code of Conduct

## Contributor Code of Conduct

Expand Down Expand Up @@ -32,6 +32,6 @@ Conduct may be permanently removed from the project team.
This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Loodse Conduct Committee via coc@loodse.com.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Kubermatic Conduct Committee via coc@kubermatic.com.

This Code of Conduct is adapted from the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) and [Contributor Covenant](http://contributor-covenant.org/version/1/2/0/), version 1.2.0.
3 changes: 1 addition & 2 deletions hack/boilerplate/boilerplate.Dockerfile.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright YEAR The XXX Authors.
# Copyright YEAR The Kubermatic fubectl Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -11,4 +11,3 @@
# 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.

3 changes: 1 addition & 2 deletions hack/boilerplate/boilerplate.Makefile.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright YEAR The XXX Authors.
# Copyright YEAR The Kubermatic fubectl Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -11,4 +11,3 @@
# 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.

3 changes: 1 addition & 2 deletions hack/boilerplate/boilerplate.bzl.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright YEAR The XXX Authors.
# Copyright YEAR The Kubermatic fubectl Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -11,4 +11,3 @@
# 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.

3 changes: 1 addition & 2 deletions hack/boilerplate/boilerplate.generatego.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright The XXX Authors.
Copyright The Kubermatic fubectl Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -13,4 +13,3 @@ 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.
*/

Loading

0 comments on commit b898b97

Please sign in to comment.