Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add namespaces in knative/pkg #235

Merged
merged 1 commit into from
Jan 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions system/clock.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
Copyright 2019 The Knative Authors

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 system

import (
"time"
)

// Mockable interface for time based testing
type Clock interface {
Now() time.Time
}

type RealClock struct{}

func (RealClock) Now() time.Time {
return time.Now()
}
52 changes: 52 additions & 0 deletions system/names.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
Copyright 2019 The Knative Authors

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 system

import (
"fmt"
"os"
)

const (
NamespaceEnvKey = "SYSTEM_NAMESPACE"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i am big fan of prefixing env vars with owner name eg KN_SYSTEM_NAMESPACE or something like that. wdyt?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add prefixing sounds good. If we change to KN_SYSTEM_NAMESPACE here, do we need to synchronize this to the config yaml file in knative/serving/config, knative/build/config and knative/eventing/config.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If anything I'd go with KNATIVE_, but I could see myself using this package beyond Knative controllers too, so having the key be agnostic could also be useful.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to @mattmoor . If this pkg use in common place, then I insist the name SYSTEM_NAMESPACE

)

// Namespace holds the K8s namespace where our serving system
// components run.
func Namespace() string {
if ns := os.Getenv(NamespaceEnvKey); ns != "" {
return ns
}

panic(fmt.Sprintf(`The environment variable %q is not set

If this is a process running on Kubernetes, then it should be using the downward
API to initialize this variable via:

env:
- name: %s
valueFrom:
fieldRef:
fieldPath: metadata.namespace

If this is a Go unit test consuming system.Namespace() then it should add the
following import:

import (
_ "github.com/knative/pkg/system/testing"
)`, NamespaceEnvKey, NamespaceEnvKey))
}
27 changes: 27 additions & 0 deletions system/testing/names.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
Copyright 2019 The Knative Authors

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

https://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 testing

import (
"os"

"github.com/knative/pkg/system"
)

func init() {
os.Setenv(system.NamespaceEnvKey, "knative-testing")
}