airship/airshipctl
Code Issues Proposed changes

Refactored airshipctl config

Browse Source 
Removed Modules from config. There are no other types of modules
that need additional configuration. BootstrapInfo is defined
in the config directly.

Used camelCase for config parameters.

Change-Id: I3531a061026f3b2f1e72af6272ba4709f28d1b3d
This commit is contained in:
Stanislav Egorov 2020-04-20 16:27:59 -07:00
parent 68c97923e1
commit cd9b4dddb4
29 changed files with 247 additions and 299 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-all-ephemeral.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterBar Cluster: clusterBar
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_ephemeral clusterKubeconf: clusterBar_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -9,8 +9,8 @@ server: ""
Cluster: clusterBar Cluster: clusterBar
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_target clusterKubeconf: clusterBar_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -18,8 +18,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_ephemeral clusterKubeconf: clusterBaz_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -27,8 +27,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_target clusterKubeconf: clusterBaz_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -36,8 +36,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_ephemeral clusterKubeconf: clusterFoo_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -45,8 +45,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_target clusterKubeconf: clusterFoo_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

24
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-all-target.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterBar Cluster: clusterBar
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_ephemeral clusterKubeconf: clusterBar_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -9,8 +9,8 @@ server: ""
Cluster: clusterBar Cluster: clusterBar
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_target clusterKubeconf: clusterBar_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -18,8 +18,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_ephemeral clusterKubeconf: clusterBaz_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -27,8 +27,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_target clusterKubeconf: clusterBaz_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -36,8 +36,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_ephemeral clusterKubeconf: clusterFoo_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -45,8 +45,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_target clusterKubeconf: clusterFoo_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

4
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-ephemeral.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterFoo Cluster: clusterFoo
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_ephemeral clusterKubeconf: clusterFoo_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

24
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-multiple-ephemeral.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterBar Cluster: clusterBar
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_ephemeral clusterKubeconf: clusterBar_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -9,8 +9,8 @@ server: ""
Cluster: clusterBar Cluster: clusterBar
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_target clusterKubeconf: clusterBar_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -18,8 +18,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_ephemeral clusterKubeconf: clusterBaz_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -27,8 +27,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_target clusterKubeconf: clusterBaz_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -36,8 +36,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_ephemeral clusterKubeconf: clusterFoo_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -45,8 +45,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_target clusterKubeconf: clusterFoo_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

24
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-multiple-target.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterBar Cluster: clusterBar
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_ephemeral clusterKubeconf: clusterBar_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -9,8 +9,8 @@ server: ""
Cluster: clusterBar Cluster: clusterBar
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBar_target clusterKubeconf: clusterBar_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -18,8 +18,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_ephemeral clusterKubeconf: clusterBaz_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -27,8 +27,8 @@ server: ""
Cluster: clusterBaz Cluster: clusterBaz
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterBaz_target clusterKubeconf: clusterBaz_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -36,8 +36,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_ephemeral clusterKubeconf: clusterFoo_ephemeral
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true
@ -45,8 +45,8 @@ server: ""
Cluster: clusterFoo Cluster: clusterFoo
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_target clusterKubeconf: clusterFoo_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

4
cmd/config/testdata/TestGetClusterCmdGoldenOutput/get-target.golden vendored
View File

@ -1,7 +1,7 @@
Cluster: clusterFoo Cluster: clusterFoo
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: clusterFoo_target clusterKubeconf: clusterFoo_target
LocationOfOrigin: "" LocationOfOrigin: ""
insecure-skip-tls-verify: true insecure-skip-tls-verify: true

6
cmd/config/testdata/TestGetContextCmdGoldenOutput/get-all-contexts.golden vendored
View File

@ -1,5 +1,5 @@
Context: ContextBar Context: ContextBar
context-kubeconf: ContextBar_ephemeral contextKubeconf: ContextBar_ephemeral
manifest: Manifest_ContextBar manifest: Manifest_ContextBar
LocationOfOrigin: "" LocationOfOrigin: ""
@ -9,7 +9,7 @@ user: dummy_user
Context: ContextBaz Context: ContextBaz
context-kubeconf: ContextBaz_ephemeral contextKubeconf: ContextBaz_ephemeral
manifest: Manifest_ContextBaz manifest: Manifest_ContextBaz
LocationOfOrigin: "" LocationOfOrigin: ""
@ -19,7 +19,7 @@ user: dummy_user
Context: ContextFoo Context: ContextFoo
context-kubeconf: ContextFoo_ephemeral contextKubeconf: ContextFoo_ephemeral
manifest: Manifest_ContextFoo manifest: Manifest_ContextFoo
LocationOfOrigin: "" LocationOfOrigin: ""

2
cmd/config/testdata/TestGetContextCmdGoldenOutput/get-context.golden vendored
View File

@ -1,5 +1,5 @@
Context: ContextFoo Context: ContextFoo
context-kubeconf: ContextFoo_ephemeral contextKubeconf: ContextFoo_ephemeral
manifest: Manifest_ContextFoo manifest: Manifest_ContextFoo
LocationOfOrigin: "" LocationOfOrigin: ""

2
cmd/config/testdata/TestGetContextCmdGoldenOutput/get-current-context.golden vendored
View File

@ -1,5 +1,5 @@
Context: ContextBaz Context: ContextBaz
context-kubeconf: ContextBaz_ephemeral contextKubeconf: ContextBaz_ephemeral
manifest: Manifest_ContextBaz manifest: Manifest_ContextBaz
LocationOfOrigin: "" LocationOfOrigin: ""

6
cmd/config/testdata/TestGetContextCmdGoldenOutput/get-multiple-contexts.golden vendored
View File

@ -1,5 +1,5 @@
Context: ContextBar Context: ContextBar
context-kubeconf: ContextBar_ephemeral contextKubeconf: ContextBar_ephemeral
manifest: Manifest_ContextBar manifest: Manifest_ContextBar
LocationOfOrigin: "" LocationOfOrigin: ""
@ -9,7 +9,7 @@ user: dummy_user
Context: ContextBaz Context: ContextBaz
context-kubeconf: ContextBaz_ephemeral contextKubeconf: ContextBaz_ephemeral
manifest: Manifest_ContextBaz manifest: Manifest_ContextBaz
LocationOfOrigin: "" LocationOfOrigin: ""
@ -19,7 +19,7 @@ user: dummy_user
Context: ContextFoo Context: ContextFoo
context-kubeconf: ContextFoo_ephemeral contextKubeconf: ContextFoo_ephemeral
manifest: Manifest_ContextFoo manifest: Manifest_ContextFoo
LocationOfOrigin: "" LocationOfOrigin: ""

44
pkg/cluster/initinfra/testdata/config.yaml vendored
View File

@ -1,42 +1,44 @@
apiVersion: airshipit.org/v1alpha1 apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
dummy_bootstrap_config:
container:
volume: /tmp/airship:/config
image: quay.io/airshipit/isogen:latest
containerRuntime: docker
builder:
userDataFileName: user-data
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
remoteDirect:
isoUrl: http://localhost:8099/debian-custom.iso
remoteType: redfish
clusters: clusters:
dummycluster: dummycluster:
cluster-type: clusterType:
ephemeral: ephemeral:
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummycluster_ephemeral clusterKubeconf: dummycluster_ephemeral
contexts: contexts:
dummy_cluster: dummy_cluster:
context-kubeconf: dummy_cluster contextKubeconf: dummy_cluster
manifest: dummy_manifest manifest: dummy_manifest
current-context: dummy_cluster currentContext: dummy_cluster
kind: Config kind: Config
manifests: manifests:
dummy_manifest: dummy_manifest:
primary-repository-name: primary primaryRepositoryName: primary
repositories: repositories:
primary: primary:
auth: auth:
ssh-key: testdata/test-key.pem sshKey: testdata/test-key.pem
type: ssh-key type: ssh-key
checkout: checkout:
branch: "" branch: ""
force: false force: false
remote-ref: "" remoteRef: ""
tag: v1.0.1 tag: v1.0.1
url: http://dummy.url.com/primary.git url: http://dummy.url.com/primary.git
sub-path: primary/site/test-site subPath: primary/site/test-site
target-path: testdata targetPath: testdata
modules-config:
bootstrapInfo:
dummy_bootstrap_config:
container:
volume: /tmp/airship:/config
image: quay.io/airshipit/isogen:latest
containerRuntime: docker
builder:
userDataFileName: user-data
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
users: users:
dummy_user: {} dummy_user: {}

13
pkg/config/config.go
View File

@ -716,11 +716,11 @@ func (c *Config) CurrentContextBootstrapInfo() (*Bootstrap, error) {
if currentCluster.Bootstrap == "" { if currentCluster.Bootstrap == "" {
return nil, ErrMissingConfig{ return nil, ErrMissingConfig{
What: fmt.Sprintf("No bootstrap-info defined for context %q", c.CurrentContext), What: fmt.Sprintf("No bootstrapInfo defined for context %q", c.CurrentContext),
} }
} }
bootstrap, exists := c.ModulesConfig.BootstrapInfo[currentCluster.Bootstrap] bootstrap, exists := c.BootstrapInfo[currentCluster.Bootstrap]
if !exists { if !exists {
return nil, ErrBootstrapInfoNotFound{Name: currentCluster.Bootstrap} return nil, ErrBootstrapInfoNotFound{Name: currentCluster.Bootstrap}
} }
@ -815,15 +815,6 @@ func (m *Manifest) String() string {
return string(yamlData) return string(yamlData)
} }
// Modules functions
func (m *Modules) String() string {
yamlData, err := yaml.Marshal(&m)
if err != nil {
return ""
}
return string(yamlData)
}
// Bootstrap functions // Bootstrap functions
func (b *Bootstrap) String() string { func (b *Bootstrap) String() string {
yamlData, err := yaml.Marshal(&b) yamlData, err := yaml.Marshal(&b)

14
pkg/config/config_test.go
View File

@ -61,10 +61,6 @@ func TestString(t *testing.T) {
name: "manifest", name: "manifest",
stringer: testutil.DummyManifest(), stringer: testutil.DummyManifest(),
}, },
{
name: "modules",
stringer: testutil.DummyModules(),
},
{ {
name: "repository", name: "repository",
stringer: testutil.DummyRepository(), stringer: testutil.DummyRepository(),
@ -78,12 +74,8 @@ func TestString(t *testing.T) {
stringer: testutil.DummyRepoCheckout(), stringer: testutil.DummyRepoCheckout(),
}, },
{ {
name: "bootstrap", name: "bootstrapinfo",
stringer: testutil.DummyBootstrap(), stringer: testutil.DummyBootstrapInfo(),
},
{
name: "bootstrap",
stringer: testutil.DummyBootstrap(),
}, },
{ {
name: "builder", name: "builder",
@ -282,7 +274,7 @@ func TestCurrentContextBootstrapInfo(t *testing.T) {
bootstrapInfo, err = conf.CurrentContextBootstrapInfo() bootstrapInfo, err = conf.CurrentContextBootstrapInfo()
require.NoError(t, err) require.NoError(t, err)
assert.Equal(t, conf.ModulesConfig.BootstrapInfo[defaultString], bootstrapInfo) assert.Equal(t, conf.BootstrapInfo[defaultString], bootstrapInfo)
} }
func TestPurge(t *testing.T) { func TestPurge(t *testing.T) {

34
pkg/config/repo_test.go
View File

@ -42,7 +42,7 @@ const (
url: git@github.com:go-git/go-git.git url: git@github.com:go-git/go-git.git
auth: auth:
type: ssh-key type: ssh-key
ssh-key: "testdata/test-key.pem" sshKey: "testdata/test-key.pem"
username: git username: git
checkout: checkout:
branch: master branch: master
@ -50,62 +50,62 @@ const (
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: ssh-pass type: ssh-pass
ssh-pass: "qwerty123" sshPass: "qwerty123"
username: deployer username: deployer
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8 commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8
http-basic-auth: http-basic-auth:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: http-basic type: http-basic
http-pass: "qwerty123" httpPass: "qwerty123"
username: deployer username: deployer
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8 commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8
empty-checkout: empty-checkout:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: http-basic type: http-basic
http-pass: "qwerty123" httpPass: "qwerty123"
username: deployer username: deployer
wrong-type-auth: wrong-type-auth:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: wrong-type type: wrong-type
http-pass: "qwerty123" httpPass: "qwerty123"
username: deployer username: deployer
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8 commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8
mutually-exclusive-auth-opts: mutually-exclusive-auth-opts:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: http-basic type: http-basic
ssh-key: "/path-to-key" sshKey: "/path-to-key"
username: deployer username: deployer
mutually-exclusive-checkout-opts: mutually-exclusive-checkout-opts:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8 commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8
branch: master branch: master
mutually-exclusive-auth-opts-ssh-key: mutually-exclusive-auth-opts-ssh-key:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: ssh-key type: ssh-key
http-pass: "qwerty123" httpPass: "qwerty123"
ssh-key: "/path-to-key" sshKey: "/path-to-key"
username: deployer username: deployer
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8 commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8
mutually-exclusive-auth-opts-ssh-pass: mutually-exclusive-auth-opts-ssh-pass:
url: /home/ubuntu/some-gitrepo url: /home/ubuntu/some-gitrepo
auth: auth:
type: ssh-pass type: ssh-pass
ssh-pass: "qwerty123" sshPass: "qwerty123"
http-pass: "qwerty123" httpPass: "qwerty123"
ssh-key: "/path-to-key" sshKey: "/path-to-key"
username: deployer username: deployer
checkout: checkout:
commit-hash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8` commitHash: 01c4f7f32beb9851ae8f119a6b8e497d2b1e2bb8`
) )
var ( var (

0
pkg/config/testdata/bootstrap-string.yaml → pkg/config/testdata/bootstrapinfo-string.yaml vendored
View File

4
pkg/config/testdata/cluster-string.yaml vendored
View File

@ -1,5 +1,5 @@
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummy_cluster_target clusterKubeconf: dummy_cluster_target
LocationOfOrigin: "" LocationOfOrigin: ""
certificate-authority: dummy_ca certificate-authority: dummy_ca

45
pkg/config/testdata/config-string.yaml vendored
View File

@ -1,45 +1,44 @@
apiVersion: airshipit.org/v1alpha1 apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
dummy_bootstrap_config:
builder:
networkConfigFileName: netconfig
outputMetadataFileName: output-metadata.yaml
userDataFileName: user-data
container:
containerRuntime: docker
image: dummy_image:dummy_tag
volume: /dummy:dummy
clusters: clusters:
dummy_cluster: dummy_cluster:
cluster-type: clusterType:
ephemeral: ephemeral:
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummy_cluster_ephemeral clusterKubeconf: dummy_cluster_ephemeral
target: target:
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummy_cluster_target clusterKubeconf: dummy_cluster_target
contexts: contexts:
dummy_context: dummy_context:
context-kubeconf: dummy_cluster_ephemeral contextKubeconf: dummy_cluster_ephemeral
manifest: dummy_manifest manifest: dummy_manifest
current-context: dummy_context currentContext: dummy_context
kind: Config kind: Config
manifests: manifests:
dummy_manifest: dummy_manifest:
primary-repository-name: primary primaryRepositoryName: primary
repositories: repositories:
primary: primary:
auth: auth:
ssh-key: testdata/test-key.pem sshKey: testdata/test-key.pem
type: ssh-key type: ssh-key
checkout: checkout:
branch: "" branch: ""
force: false force: false
remote-ref: "" remoteRef: ""
tag: v1.0.1 tag: v1.0.1
url: http://dummy.url.com/manifests.git url: http://dummy.url.com/manifests.git
sub-path: manifests/site/test-site subPath: manifests/site/test-site
target-path: /var/tmp/ targetPath: /var/tmp/
modules-config:
bootstrapInfo:
dummy_bootstrap_config:
builder:
networkConfigFileName: netconfig
outputMetadataFileName: output-metadata.yaml
userDataFileName: user-data
container:
containerRuntime: docker
image: dummy_image:dummy_tag
volume: /dummy:dummy
users: users:
dummy_user: {} dummy_user: {}

2
pkg/config/testdata/context-string.yaml vendored
View File

@ -1,4 +1,4 @@
context-kubeconf: dummy_cluster_ephemeral contextKubeconf: dummy_cluster_ephemeral
manifest: dummy_manifest manifest: dummy_manifest
LocationOfOrigin: "" LocationOfOrigin: ""

10
pkg/config/testdata/manifest-string.yaml vendored
View File

@ -1,14 +1,14 @@
primary-repository-name: primary primaryRepositoryName: primary
repositories: repositories:
primary: primary:
auth: auth:
ssh-key: testdata/test-key.pem sshKey: testdata/test-key.pem
type: ssh-key type: ssh-key
checkout: checkout:
branch: "" branch: ""
force: false force: false
remote-ref: "" remoteRef: ""
tag: v1.0.1 tag: v1.0.1
url: http://dummy.url.com/manifests.git url: http://dummy.url.com/manifests.git
sub-path: manifests/site/test-site subPath: manifests/site/test-site
target-path: /var/tmp/ targetPath: /var/tmp/

10
pkg/config/testdata/modules-string.yaml vendored
View File

@ -1,10 +0,0 @@
bootstrapInfo:
dummy_bootstrap_config:
builder:
networkConfigFileName: netconfig
outputMetadataFileName: output-metadata.yaml
userDataFileName: user-data
container:
containerRuntime: docker
image: dummy_image:dummy_tag
volume: /dummy:dummy

4
pkg/config/testdata/prettycluster-string.yaml vendored
View File

@ -1,7 +1,7 @@
Cluster: dummy_cluster Cluster: dummy_cluster
target: target:
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummy_cluster_target clusterKubeconf: dummy_cluster_target
LocationOfOrigin: "" LocationOfOrigin: ""
certificate-authority: dummy_ca certificate-authority: dummy_ca

2
pkg/config/testdata/repo-auth-string.yaml vendored
View File

@ -1,2 +1,2 @@
ssh-key: testdata/test-key.pem sshKey: testdata/test-key.pem
type: ssh-key type: ssh-key

2
pkg/config/testdata/repo-checkout-string.yaml vendored
View File

@ -1,4 +1,4 @@
branch: "" branch: ""
force: false force: false
remote-ref: "" remoteRef: ""
tag: v1.0.1 tag: v1.0.1

4
pkg/config/testdata/repository-string.yaml vendored
View File

@ -1,9 +1,9 @@
auth: auth:
ssh-key: testdata/test-key.pem sshKey: testdata/test-key.pem
type: ssh-key type: ssh-key
checkout: checkout:
branch: "" branch: ""
force: false force: false
remote-ref: "" remoteRef: ""
tag: v1.0.1 tag: v1.0.1
url: http://dummy.url.com/manifests.git url: http://dummy.url.com/manifests.git

42
pkg/config/types.go
View File

@ -47,12 +47,10 @@ type Config struct {
Manifests map[string]*Manifest `json:"manifests"` Manifests map[string]*Manifest `json:"manifests"`
// CurrentContext is the name of the context that you would like to use by default // CurrentContext is the name of the context that you would like to use by default
CurrentContext string `json:"current-context"` CurrentContext string `json:"currentContext"`
// Modules Section // BootstrapInfo is the configuration for container runtime, ISO builder and remote management
// Will store configuration required by the different airshipctl modules BootstrapInfo map[string]*Bootstrap `json:"bootstrapInfo"`
// Such as Bootstrap, Workflows, Document, etc
ModulesConfig *Modules `json:"modules-config"`
// loadedConfigPath is the full path to the the location of the config // loadedConfigPath is the full path to the the location of the config
// file from which this config was loaded // file from which this config was loaded
@ -71,34 +69,26 @@ type Config struct {
// ClusterPurpose encapsulates the Cluster Type as an enumeration // ClusterPurpose encapsulates the Cluster Type as an enumeration
type ClusterPurpose struct { type ClusterPurpose struct {
// Cluster map of referenceable names to cluster configs // Cluster map of referenceable names to cluster configs
ClusterTypes map[string]*Cluster `json:"cluster-type"` ClusterTypes map[string]*Cluster `json:"clusterType"`
} }
// Cluster contains information about how to communicate with a kubernetes cluster // Cluster contains information about how to communicate with a kubernetes cluster
type Cluster struct { type Cluster struct {
// Complex cluster name defined by the using <cluster name>_<cluster type>) // Complex cluster name defined by the using <cluster name>_<cluster type>)
NameInKubeconf string `json:"cluster-kubeconf"` NameInKubeconf string `json:"clusterKubeconf"`
// KubeConfig Cluster Object // KubeConfig Cluster Object
cluster *kubeconfig.Cluster cluster *kubeconfig.Cluster
// Bootstrap configuration this clusters ephemeral hosts will rely on // Bootstrap configuration this clusters ephemeral hosts will rely on
Bootstrap string `json:"bootstrap-info"` Bootstrap string `json:"bootstrapInfo"`
}
// Modules encapsulates all module configurations
// Configuration that the Bootstrap Module would need
// Configuration that the Document Module would need
// Configuration that the Workflows Module would need
type Modules struct {
BootstrapInfo map[string]*Bootstrap `json:"bootstrapInfo"`
} }
// Context is a tuple of references to a cluster (how do I communicate with a kubernetes context), // Context is a tuple of references to a cluster (how do I communicate with a kubernetes context),
// a user (how do I identify myself), and a namespace (what subset of resources do I want to work with) // a user (how do I identify myself), and a namespace (what subset of resources do I want to work with)
type Context struct { type Context struct {
// Context name in kubeconf // Context name in kubeconf
NameInKubeconf string `json:"context-kubeconf"` NameInKubeconf string `json:"contextKubeconf"`
// Manifest is the default manifest to be use with this context // Manifest is the default manifest to be use with this context
// +optional // +optional
@ -118,18 +108,18 @@ type AuthInfo struct {
type Manifest struct { type Manifest struct {
// PrimaryRepositoryName is a name of the repo, that contains site/<site-name> directory // PrimaryRepositoryName is a name of the repo, that contains site/<site-name> directory
// and is a starting point for building document bundle // and is a starting point for building document bundle
PrimaryRepositoryName string `json:"primary-repository-name"` PrimaryRepositoryName string `json:"primaryRepositoryName"`
// ExtraRepositories is the map of extra repositories addressable by a name // ExtraRepositories is the map of extra repositories addressable by a name
Repositories map[string]*Repository `json:"repositories,omitempty"` Repositories map[string]*Repository `json:"repositories,omitempty"`
// TargetPath Local Target path for working or home dirctory for all Manifest Cloned/Returned/Generated // TargetPath Local Target path for working or home dirctory for all Manifest Cloned/Returned/Generated
TargetPath string `json:"target-path"` TargetPath string `json:"targetPath"`
// SubPath is a path relative to TargetPath + Path where PrimaryRepository is cloned and contains // SubPath is a path relative to TargetPath + Path where PrimaryRepository is cloned and contains
// directories with ClusterType and Phase bundles, example: // directories with ClusterType and Phase bundles, example:
// Repositories[PrimaryRepositoryName].Url = 'https://github.com/airshipit/treasuremap' // Repositories[PrimaryRepositoryName].Url = 'https://github.com/airshipit/treasuremap'
// SubPath = "manifests" // SubPath = "manifests"
// you would expect that at treasuremap/manifests you would have ephemeral/initinfra and // you would expect that at treasuremap/manifests you would have ephemeral/initinfra and
// ephemera/target directories, containing kustomize.yaml. // ephemera/target directories, containing kustomize.yaml.
SubPath string `json:"sub-path"` SubPath string `json:"subPath"`
} }
// Repository is a tuple that holds the information for the remote sources of manifest yaml documents. // Repository is a tuple that holds the information for the remote sources of manifest yaml documents.
@ -150,13 +140,13 @@ type RepoAuth struct {
// supported types are "ssh-key", "ssh-pass", "http-basic" // supported types are "ssh-key", "ssh-pass", "http-basic"
Type string `json:"type,omitempty"` Type string `json:"type,omitempty"`
//KeyPassword is a password decrypt ssh private key (used with ssh-key auth type) //KeyPassword is a password decrypt ssh private key (used with ssh-key auth type)
KeyPassword string `json:"key-pass,omitempty"` KeyPassword string `json:"keyPass,omitempty"`
// KeyPath is path to private ssh key on disk (used with ssh-key auth type) // KeyPath is path to private ssh key on disk (used with ssh-key auth type)
KeyPath string `json:"ssh-key,omitempty"` KeyPath string `json:"sshKey,omitempty"`
//HTTPPassword is password for basic http authentication (used with http-basic auth type) //HTTPPassword is password for basic http authentication (used with http-basic auth type)
HTTPPassword string `json:"http-pass,omitempty"` HTTPPassword string `json:"httpPass,omitempty"`
// SSHPassword is password for ssh password authentication (used with ssh-pass) // SSHPassword is password for ssh password authentication (used with ssh-pass)
SSHPassword string `json:"ssh-pass,omitempty"` SSHPassword string `json:"sshPass,omitempty"`
// Username to authenticate against git remote (used with any type) // Username to authenticate against git remote (used with any type)
Username string `json:"username,omitempty"` Username string `json:"username,omitempty"`
} }
@ -165,7 +155,7 @@ type RepoAuth struct {
// Each field is mutually exclusive // Each field is mutually exclusive
type RepoCheckout struct { type RepoCheckout struct {
// CommitHash is full hash of the commit that will be used to checkout // CommitHash is full hash of the commit that will be used to checkout
CommitHash string `json:"commit-hash,omitempty"` CommitHash string `json:"commitHash,omitempty"`
// Branch is the branch name to checkout // Branch is the branch name to checkout
Branch string `json:"branch"` Branch string `json:"branch"`
// Tag is the tag name to checkout // Tag is the tag name to checkout
@ -174,7 +164,7 @@ type RepoCheckout struct {
// RemoteRef is used for remote checkouts such as gerrit change requests/github pull request // RemoteRef is used for remote checkouts such as gerrit change requests/github pull request
// for example refs/changes/04/691202/5 // for example refs/changes/04/691202/5
// TODO Add support for fetching remote refs // TODO Add support for fetching remote refs
RemoteRef string `json:"remote-ref"` RemoteRef string `json:"remoteRef"`
// ForceCheckout is a boolean to indicate whether to use the `--force` option when checking out // ForceCheckout is a boolean to indicate whether to use the `--force` option when checking out
ForceCheckout bool `json:"force"` ForceCheckout bool `json:"force"`
} }

48
pkg/config/utils.go
View File

@ -27,8 +27,26 @@ func NewConfig() *Config {
return &Config{ return &Config{
Kind: AirshipConfigKind, Kind: AirshipConfigKind,
APIVersion: AirshipConfigAPIVersion, APIVersion: AirshipConfigAPIVersion,
Clusters: make(map[string]*ClusterPurpose), BootstrapInfo: map[string]*Bootstrap{
AuthInfos: make(map[string]*AuthInfo), AirshipDefaultContext: {
Container: &Container{
Volume: "/srv/iso:/config",
Image: AirshipDefaultBootstrapImage,
ContainerRuntime: "docker",
},
Builder: &Builder{
UserDataFileName: "user-data",
NetworkConfigFileName: "network-config",
OutputMetadataFileName: "output-metadata.yaml",
},
RemoteDirect: &RemoteDirect{
RemoteType: AirshipDefaultRemoteType,
IsoURL: AirshipDefaultIsoURL,
},
},
},
Clusters: make(map[string]*ClusterPurpose),
AuthInfos: make(map[string]*AuthInfo),
Contexts: map[string]*Context{ Contexts: map[string]*Context{
AirshipDefaultContext: { AirshipDefaultContext: {
Manifest: AirshipDefaultManifest, Manifest: AirshipDefaultManifest,
@ -51,26 +69,6 @@ func NewConfig() *Config {
SubPath: AirshipDefaultManifestRepo + "/manifests/site", SubPath: AirshipDefaultManifestRepo + "/manifests/site",
}, },
}, },
ModulesConfig: &Modules{
BootstrapInfo: map[string]*Bootstrap{
AirshipDefaultContext: {
Container: &Container{
Volume: "/srv/iso:/config",
Image: AirshipDefaultBootstrapImage,
ContainerRuntime: "docker",
},
Builder: &Builder{
UserDataFileName: "user-data",
NetworkConfigFileName: "network-config",
OutputMetadataFileName: "output-metadata.yaml",
},
RemoteDirect: &RemoteDirect{
RemoteType: AirshipDefaultRemoteType,
IsoURL: AirshipDefaultIsoURL,
},
},
},
},
} }
} }
@ -101,12 +99,6 @@ func NewAuthInfo() *AuthInfo {
return &AuthInfo{} return &AuthInfo{}
} }
func NewModules() *Modules {
return &Modules{
BootstrapInfo: make(map[string]*Bootstrap),
}
}
// NewClusterPurpose is a convenience function that returns a new ClusterPurpose // NewClusterPurpose is a convenience function that returns a new ClusterPurpose
func NewClusterPurpose() *ClusterPurpose { func NewClusterPurpose() *ClusterPurpose {
return &ClusterPurpose{ return &ClusterPurpose{

49
roles/airshipctl-test-configs/templates/airshipconfig.j2
View File

@ -1,47 +1,46 @@
apiVersion: airshipit.org/v1alpha1 apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
dummy_bootstrap_config:
container:
volume: {{ airship_config_iso_gen_target_path }}:/config
image: {{ airship_config_iso_builder_docker_image }}
containerRuntime: docker
remoteDirect:
remoteType: {{ remote_type }}
insecure: {{ remote_insecure }}
useproxy: {{ remote_proxy }}
isoUrl: http://{{ airship_config_iso_serve_host }}:{{ airship_config_iso_port }}/{{ airship_config_iso_name }}
builder:
userDataFileName: user-data
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
clusters: clusters:
dummycluster: dummycluster:
cluster-type: clusterType:
ephemeral: ephemeral:
bootstrap-info: dummy_bootstrap_config bootstrapInfo: dummy_bootstrap_config
cluster-kubeconf: dummycluster_ephemeral clusterKubeconf: dummycluster_ephemeral
contexts: contexts:
dummy_cluster: dummy_cluster:
context-kubeconf: dummy_cluster contextKubeconf: dummy_cluster
manifest: dummy_manifest manifest: dummy_manifest
current-context: dummy_cluster currentContext: dummy_cluster
kind: Config kind: Config
manifests: manifests:
dummy_manifest: dummy_manifest:
primary-repository-name: primary primaryRepositoryName: primary
repositories: repositories:
primary: primary:
checkout: checkout:
branch: "master" branch: "master"
force: false force: false
remote-ref: "" remoteRef: ""
tag: "" tag: ""
url: {{ airship_config_primary_repo_url }} url: {{ airship_config_primary_repo_url }}
## this is temporary hack, as soon as we use `document pull` command in gate process ## this is temporary hack, as soon as we use `document pull` command in gate process
## this will subpath will be airshipctl/manifests/site/test-bootstrap, as airshipctl ## this will subpath will be airshipctl/manifests/site/test-bootstrap, as airshipctl
## will be primary repository ## will be primary repository
sub-path: {{ airship_site_name }} subPath: {{ airship_site_name }}
target-path: {{ airship_config_manifest_directory }} targetPath: {{ airship_config_manifest_directory }}
modules-config:
bootstrapInfo:
dummy_bootstrap_config:
container:
volume: {{ airship_config_iso_gen_target_path }}:/config
image: {{ airship_config_iso_builder_docker_image }}
containerRuntime: docker
remoteDirect:
remoteType: {{ remote_type }}
insecure: {{ remote_insecure }}
useproxy: {{ remote_proxy }}
isoUrl: http://{{ airship_config_iso_serve_host }}:{{ airship_config_iso_port }}/{{ airship_config_iso_name }}
builder:
userDataFileName: user-data
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
users: users:
dummy_user: {} dummy_user: {}

45
testdata/k8s/config.yaml vendored
View File

@ -1,42 +1,41 @@
apiVersion: airshipit.org/v1alpha1 apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
default:
builder:
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
userDataFileName: user-data
container:
containerRuntime: docker
image: quay.io/airshipit/isogen:latest
volume: /srv/iso:/config
remoteDirect:
isoUrl: http://localhost:8099/debian-custom.iso
remoteType: redfish
clusters: clusters:
default: default:
cluster-type: clusterType:
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: default_target clusterKubeconf: default_target
kubernetes: kubernetes:
cluster-type: {} clusterType: {}
contexts: contexts:
default: default:
context-kubeconf: default_target contextKubeconf: default_target
manifest: default manifest: default
current-context: "" currentContext: ""
kind: Config kind: Config
manifests: manifests:
default: default:
repository: repository:
checkout: checkout:
branch: master branch: master
commit-hash: master commitHash: master
force: false force: false
remote-ref: master remoteRef: master
tag: "" tag: ""
url: https://opendev.org/airship/treasuremap url: https://opendev.org/airship/treasuremap
target-path: /tmp/default targetPath: /tmp/default
modules-config:
bootstrapInfo:
default:
builder:
networkConfigFileName: network-config
outputMetadataFileName: output-metadata.yaml
userDataFileName: user-data
container:
containerRuntime: docker
image: quay.io/airshipit/isogen:latest
volume: /srv/iso:/config
remoteDirect:
isoUrl: http://localhost:8099/debian-custom.iso
remoteType: redfish
users: users:
admin: {} admin: {}

54
testutil/testconfig.go
View File

@ -47,7 +47,9 @@ func DummyConfig() *config.Config {
Manifests: map[string]*config.Manifest{ Manifests: map[string]*config.Manifest{
"dummy_manifest": DummyManifest(), "dummy_manifest": DummyManifest(),
}, },
ModulesConfig: DummyModules(), BootstrapInfo: map[string]*config.Bootstrap{
"dummy_bootstrap_config": DummyBootstrapInfo(),
},
CurrentContext: "dummy_context", CurrentContext: "dummy_context",
} }
conf.SetKubeConfig(kubeconfig.NewConfig()) conf.SetKubeConfig(kubeconfig.NewConfig())
@ -154,13 +156,6 @@ func DummyKubeAuthInfo() *kubeconfig.AuthInfo {
return authinfo return authinfo
} }
// DummyModules returns Modules config objects for unit testing
func DummyModules() *config.Modules {
m := config.NewModules()
m.BootstrapInfo["dummy_bootstrap_config"] = DummyBootstrap()
return m
}
// DummyClusterPurpose creates ClusterPurpose config object for unit testing // DummyClusterPurpose creates ClusterPurpose config object for unit testing
func DummyClusterPurpose() *config.ClusterPurpose { func DummyClusterPurpose() *config.ClusterPurpose {
cp := config.NewClusterPurpose() cp := config.NewClusterPurpose()
@ -234,8 +229,7 @@ func DummyAuthInfoOptions() *config.AuthInfoOptions {
return authinfo return authinfo
} }
// DummyBootstrap creates Bootstrap config object for unit testing func DummyBootstrapInfo() *config.Bootstrap {
func DummyBootstrap() *config.Bootstrap {
bs := &config.Bootstrap{} bs := &config.Bootstrap{}
cont := config.Container{ cont := config.Container{
Volume: "/dummy:dummy", Volume: "/dummy:dummy",
@ -256,43 +250,43 @@ func DummyBootstrap() *config.Bootstrap {
const ( const (
testConfigYAML = `apiVersion: airshipit.org/v1alpha1 testConfigYAML = `apiVersion: airshipit.org/v1alpha1
bootstrapInfo:
default: {}
clusters: clusters:
straggler: straggler:
cluster-type: clusterType:
ephemeral: ephemeral:
cluster-kubeconf: notThere clusterKubeconf: notThere
def: def:
cluster-type: clusterType:
ephemeral: ephemeral:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: def_ephemeral clusterKubeconf: def_ephemeral
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: def_target clusterKubeconf: def_target
onlyinkubeconf: onlyinkubeconf:
cluster-type: clusterType:
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: onlyinkubeconf_target clusterKubeconf: onlyinkubeconf_target
wrongonlyinconfig: wrongonlyinconfig:
cluster-type: {} clusterType: {}
wrongonlyinkubeconf: wrongonlyinkubeconf:
cluster-type: clusterType:
target: target:
bootstrap-info: "" bootstrapInfo: ""
cluster-kubeconf: wrongonlyinkubeconf_target clusterKubeconf: wrongonlyinkubeconf_target
contexts: contexts:
def_ephemeral: def_ephemeral:
context-kubeconf: def_ephemeral contextKubeconf: def_ephemeral
def_target: def_target:
context-kubeconf: def_target contextKubeconf: def_target
onlyink: onlyink:
context-kubeconf: onlyinkubeconf_target contextKubeconf: onlyinkubeconf_target
current-context: "" currentContext: ""
kind: Config kind: Config
manifests: {} manifests: {}
modules-config:
dummy-for-tests: ""
users: users:
k-admin: {} k-admin: {}
k-other: {} k-other: {}