installconfig: Replace 'KeyPairName' with 'SSHKey', and fix golint, uuid #188

yifan-gu · 2018-08-27T21:54:36Z

Replace 'KeyPairName' with 'SSHKey'.
Fix golint.
Use better UUID() implementation from upstream.

abhinavdahiya · 2018-08-27T21:58:07Z

pkg/asset/installconfig/installconfig.go

- Region:  region,
- KeyPairName: keyPairName,
+ Region: region,
+ SSHKey: sshKey,


We can drop SSHKey, #127

the sshkey has moved to admin section.

yifan-gu · 2018-08-27T22:02:00Z

@wking Yeah, I was feeling like I missed something, that's it!

wking · 2018-08-27T22:02:39Z

pkg/asset/installconfig/clusterid.go

@@ -19,7 +19,7 @@ func (a *clusterID) Dependencies() []asset.Asset {
 func (a *clusterID) Generate(map[asset.Asset]*asset.State) (*asset.State, error) {
 return &asset.State{
 Contents: []asset.Content{
- {Data: []byte(uuid.NewUUID().String())},
+ {Data: []byte(uuid.NewUUID())},


Previous discussion starting here. I'd still prefer to stick to pborman/uuid and just use the random (version 4) UUID via []byte(uuid.New()).

wking · 2018-08-27T22:05:35Z

pkg/asset/installconfig/doc.go

@@ -0,0 +1,2 @@
+// Package installconfig generates the install config assets based on its dependencies


nit: you're missing a trailing period here.

And maybe add a note about these being the main settings we expect users to edit?

wking · 2018-08-27T22:07:50Z

pkg/asset/stock/doc.go

@@ -0,0 +1,2 @@
+// Package stock defines a stock type that holds the instanciated object of the assets.


nit: My aspell dictionary and wiktionary have "instantiated" but not "instanciated".

wking · 2018-08-27T22:08:31Z

pkg/types/doc.go

@@ -0,0 +1,2 @@
+// Package types defines the InstallConfig that contains user-tuneable options.


nit: Are other types going to go in here too? If it's just InstallConfig, maybe we should move that type definition into pkg/asset/installconfig.

I'm inclined to keep it here for now, as the pkg/asset is more for generating assets internally for the installer, but the InstallConfig is kinda exportable, and might be referenced by other projects like cluster-operator, etc. So I want to make it stay in a top level package for easier accessibility.

...but the InstallConfig is kinda exportable...

So this package is intended just for that struct? Or do we expect other structs to end up here as well? If it's just this one struct, how about pkg/installconfig for the struct (leaving the asset logic deeper in pkg/asset/installconfig)?

Currently I am only seeing one, but I like to have pkg/types, still more intuitive to me, even if I don't know what installconfig is, I will probably look into this package and find out.

Currently I am only seeing one, but I like to have pkg/types...

So maybe the scope is:

// Package types defines structures for user-supplied installer configuration.

without it being InstallerConfig specific?

wking · 2018-08-28T00:03:09Z

Documentation/design/installconfig.md

@@ -270,6 +268,7 @@ type InstallConfig struct {
 type Admin struct {
 Email string `json:"email"`
 Password string `json:"password"`
+ SSHKey string `json:"sshKey"`


Indent is wonky here. Maybe tabs vs. spaces?

updated to spaces, seems like that's what other fields do.

fixed other places too in the file.

wking

A few more minor nits. I'm fine with these getting fixed here, and also with 6357eda landing as it stands and punting the nits to follow-up work.

wking · 2018-08-28T03:54:52Z

pkg/asset/installconfig/doc.go

@@ -0,0 +1,4 @@
+// Package installconfig generates the install config assets based on its dependencies.
+// The definition of install config is at pkg/types/installconfig.go, it contains all


nit: pkg/types/installconfig.go is file-level detail, but folks reading this in godoc.org will only care about package-level detail. Maybe something like:

// Package installconfig generates the install config assets based on its dependencies. // The type itself is defined in ../pkg/types.

Or end with the full import path "...defined in github.com/openshift/installer/pkg/types.".

wking · 2018-08-28T03:55:50Z

pkg/asset/stock/doc.go

@@ -0,0 +1,2 @@
+// Package stock defines a stock type that holds the instantiated object of the assets.


nit: Maybe just end with "...that holds the instantiated assets."?

wking · 2018-08-28T03:59:07Z

pkg/types/installconfig.go

@@ -45,6 +45,8 @@ type Admin struct {
 Email string `json:"email"`
 // Password is the password of the admin user.
 Password string `json:"password"`
+ // SSHKey to use for the access to compute instances.
+ SSHKey string `json:"sshKey"`


nit: Should this optional type be omitempty?

why this is optional?

why this is optional?

Maybe the user doesn't care about SSH access? But mostly because it's omitempty here, and I'd rather stay consistent ;).

ok, updated

As now we will just accept the SSHKey from the prompt instead of a KeyPairName.

wking · 2018-08-28T21:10:41Z

/lgtm

openshift-ci-robot · 2018-08-28T21:10:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wking, yifan-gu

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [wking,yifan-gu]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Alex Yang <yangyang1@zte.com.cn>

openshift-ci-robot requested review from crawford and wking August 27, 2018 21:54

openshift-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 27, 2018

abhinavdahiya reviewed Aug 27, 2018

View reviewed changes

wking reviewed Aug 27, 2018

View reviewed changes

yifan-gu force-pushed the minor_state branch from b7fb682 to 7446f48 Compare August 27, 2018 23:56

openshift-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 27, 2018

yifan-gu force-pushed the minor_state branch from 7446f48 to ee35bfa Compare August 27, 2018 23:57

wking reviewed Aug 28, 2018

View reviewed changes

yifan-gu force-pushed the minor_state branch 2 times, most recently from 594fe6f to 6357eda Compare August 28, 2018 00:30

openshift-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 28, 2018

wking reviewed Aug 28, 2018

View reviewed changes

Yifan Gu added 2 commits August 28, 2018 11:04

doc.go: Add doc.go to packages to make golint happy.

17bdf3a

uuid: Use random (version 4) uuid for better randomness.

dd70d4b

yifan-gu force-pushed the minor_state branch from 6357eda to 3ab419c Compare August 28, 2018 18:04

installconfig: Replace KeyPairName with SSHKey.

a9ab9ff

As now we will just accept the SSHKey from the prompt instead of a KeyPairName.

yifan-gu force-pushed the minor_state branch from 820a7b0 to a9ab9ff Compare August 28, 2018 19:23

openshift-ci-robot assigned wking Aug 28, 2018

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 28, 2018

openshift-merge-robot merged commit 2587b3e into openshift:master Aug 28, 2018

wking mentioned this pull request Aug 28, 2018

Documentation: update installconfig #189

Merged

yifan-gu deleted the minor_state branch August 28, 2018 22:43

EmilienM pushed a commit to shiftstack/installer that referenced this pull request Dec 8, 2020

add UserDataSecret into deepcopy file (openshift#188)

2b1ecf5

Signed-off-by: Alex Yang <yangyang1@zte.com.cn>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

installconfig: Replace 'KeyPairName' with 'SSHKey', and fix golint, uuid #188

installconfig: Replace 'KeyPairName' with 'SSHKey', and fix golint, uuid #188

yifan-gu commented Aug 27, 2018

abhinavdahiya Aug 27, 2018

abhinavdahiya Aug 27, 2018

yifan-gu commented Aug 27, 2018

wking Aug 27, 2018

wking Aug 27, 2018

wking Aug 27, 2018

wking Aug 27, 2018

yifan-gu Aug 27, 2018 •

edited

Loading

wking Aug 27, 2018 •

edited

Loading

yifan-gu Aug 27, 2018

wking Aug 27, 2018

wking Aug 28, 2018

yifan-gu Aug 28, 2018

yifan-gu Aug 28, 2018

wking left a comment

wking Aug 28, 2018

wking Aug 28, 2018

wking Aug 28, 2018

yifan-gu Aug 28, 2018

wking Aug 28, 2018 •

edited

Loading

yifan-gu Aug 28, 2018

wking commented Aug 28, 2018

openshift-ci-robot commented Aug 28, 2018

		@@ -0,0 +1,2 @@
		// Package installconfig generates the install config assets based on its dependencies

		@@ -0,0 +1,2 @@
		// Package stock defines a stock type that holds the instanciated object of the assets.

		@@ -0,0 +1,2 @@
		// Package types defines the InstallConfig that contains user-tuneable options.

		@@ -0,0 +1,4 @@
		// Package installconfig generates the install config assets based on its dependencies.
		// The definition of install config is at pkg/types/installconfig.go, it contains all

installconfig: Replace 'KeyPairName' with 'SSHKey', and fix golint, uuid #188

installconfig: Replace 'KeyPairName' with 'SSHKey', and fix golint, uuid #188

Conversation

yifan-gu commented Aug 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yifan-gu commented Aug 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yifan-gu Aug 27, 2018 • edited Loading

Choose a reason for hiding this comment

wking Aug 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wking left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wking Aug 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wking commented Aug 28, 2018

openshift-ci-robot commented Aug 28, 2018

yifan-gu Aug 27, 2018 •

edited

Loading

wking Aug 27, 2018 •

edited

Loading

wking Aug 28, 2018 •

edited

Loading