Skip to content

Commit

Permalink
Adopting README, documentation and import comments
Browse files Browse the repository at this point in the history
Fixed an import grouping in kubeseal, fixed some typos in README
and an erroneous revert (changed TPR -> CRD).
  • Loading branch information
anzboi committed Apr 26, 2019
1 parent 5637f5b commit 84e7325
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,21 +130,21 @@ labelled as active.
#### Key rotation

Keys are automatically rotated. This can be configured on startup with
the `--rotate-preiod=<value>` flag. `value` is taken as milliseconds with
the `--rotate-period=<value>` flag. `value` is taken as milliseconds with
a default of 30 days.

A key can be generated early in two ways
1. Send `SIGUSR1` to the controller
`kubectl exec -it <controller pod> -- kill -SIGUSR1 1`
2. Label the current latest key as compromised (anything no active)
`kubectl label secrets <keyname> sealed-secrets-key=compromised`
2. Label the current latest key as compromised (any value other than active)
`kubectl label secrets <keyname> sealed-secrets-key=compromised`.

**NOTE** Sealed secrets currently does not automtically pick up
relabelled keys, you must restart the controller before the effect
**NOTE** Sealed secrets currently does not automatically pick up
relabelled keys, an admin must restart the controller before the effect
will apply.

Labelling a secret with anything other than `active` effectively deletes
the key from the sealed secrets controller, but it is still available for
the key from the sealed secrets controller, but it is still available in k8s for
manual encryption/decryption if need be.

## Developing
Expand Down
3 changes: 1 addition & 2 deletions cmd/kubeseal/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,12 @@ import (
"os"
"strings"

"k8s.io/apimachinery/pkg/util/net"

flag "github.com/spf13/pflag"
"k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
runtimeserializer "k8s.io/apimachinery/pkg/runtime/serializer"
"k8s.io/apimachinery/pkg/util/net"
"k8s.io/client-go/kubernetes/scheme"
corev1 "k8s.io/client-go/kubernetes/typed/core/v1"
"k8s.io/client-go/tools/clientcmd"
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/sealed-secrets/v1alpha1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
)

const (
// SealedSecretName is the name used in SealedSecret TPR
// SealedSecretName is the name used in SealedSecret CRD
SealedSecretName = "sealed-secret." + GroupName
// SealedSecretPlural is the collection plural used with SealedSecret API
SealedSecretPlural = "sealedsecrets"
Expand Down

0 comments on commit 84e7325

Please sign in to comment.