Documentation ¶
Overview ¶
Copyright 2019 The Operator-SDK 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.
Index ¶
- Constants
- Variables
- func PrintGoMod() error
- type AoLogs
- type BuildDockerfile
- type BuildTestFrameworkAnsibleTestScript
- type BuildTestFrameworkDockerfile
- type DeployOperator
- type DockerfileHybrid
- type Entrypoint
- type GoMod
- type Main
- type MoleculeDefaultAsserts
- type MoleculeDefaultMolecule
- type MoleculeDefaultPlaybook
- type MoleculeDefaultPrepare
- type MoleculeTestClusterMolecule
- type MoleculeTestClusterPlaybook
- type MoleculeTestLocalMolecule
- type MoleculeTestLocalPlaybook
- type MoleculeTestLocalPrepare
- type Playbook
- type RolesDefaultsMain
- type RolesFiles
- type RolesHandlersMain
- type RolesMetaMain
- type RolesReadme
- type RolesTasksMain
- type RolesTemplates
- type RolesVarsMain
- type StaticInput
- type Travis
- type UserSetup
- type Watches
Constants ¶
const ( RolesDir = "roles" MoleculeDir = "molecule" MoleculeTestClusterDir = MoleculeDir + filePathSep + "test-cluster" MoleculeDefaultDir = MoleculeDir + filePathSep + "default" MoleculeTestLocalDir = MoleculeDir + filePathSep + "test-local" )
const BuildDockerfileFile = "Dockerfile"
const BuildTestFrameworkAnsibleTestScriptFile = "ansible-test.sh"
const BuildTestFrameworkDockerfileFile = "Dockerfile"
const DeployOperatorFile = "operator.yaml"
const GoModFile = "go.mod"
const MoleculeDefaultAssertsFile = "asserts.yml"
const MoleculeDefaultMoleculeFile = "molecule.yml"
const MoleculeDefaultPlaybookFile = "playbook.yml"
const MoleculeDefaultPrepareFile = "prepare.yml"
const MoleculeTestClusterMoleculeFile = "molecule.yml"
const MoleculeTestClusterPlaybookFile = "playbook.yml"
const MoleculeTestLocalMoleculeFile = "molecule.yml"
const MoleculeTestLocalPlaybookFile = "playbook.yml"
const MoleculeTestLocalPrepareFile = "prepare.yml"
const PlaybookYamlFile = "playbook.yml"
const RolesDefaultsMainFile = "defaults" + filePathSep + "main.yml"
const RolesFilesDir = "files" + filePathSep + ".placeholder"
const RolesHandlersMainFile = "handlers" + filePathSep + "main.yml"
const RolesMetaMainFile = "meta" + filePathSep + "main.yml"
const RolesReadmeFile = "README.md"
const RolesTasksMainFile = "tasks" + filePathSep + "main.yml"
const RolesTemplatesDir = "templates" + filePathSep + ".placeholder"
const RolesVarsMainFile = "vars" + filePathSep + "main.yml"
const TravisFile = ".travis.yml"
const WatchesFile = "watches.yaml"
Variables ¶
var AnsibleDelims = [2]string{"[[", "]]"}
AnsibleDelims is a slice of two strings representing the left and right delimiters for ansible templates. Arrays can't be constants but this should be a constant.
Functions ¶
func PrintGoMod ¶
func PrintGoMod() error
Types ¶
type AoLogs ¶
type AoLogs struct {
StaticInput
}
DockerfileHybrid - Dockerfile for a hybrid operator
type BuildDockerfile ¶
type BuildTestFrameworkAnsibleTestScript ¶
type BuildTestFrameworkAnsibleTestScript struct {
StaticInput
}
type BuildTestFrameworkDockerfile ¶
type BuildTestFrameworkDockerfile struct {
StaticInput
}
type DeployOperator ¶
type DockerfileHybrid ¶
type DockerfileHybrid struct { input.Input // Playbook - if true, include a COPY statement for playbook.yml Playbook bool // Roles - if true, include a COPY statement for the roles directory Roles bool // Watches - if true, include a COPY statement for watches.yaml Watches bool }
DockerfileHybrid - Dockerfile for a hybrid operator
type MoleculeDefaultAsserts ¶
type MoleculeDefaultMolecule ¶
type MoleculeDefaultMolecule struct {
StaticInput
}
type MoleculeDefaultPlaybook ¶
type MoleculeDefaultPrepare ¶
type MoleculeTestClusterMolecule ¶
type MoleculeTestClusterMolecule struct {
StaticInput
}
type MoleculeTestLocalMolecule ¶
type MoleculeTestLocalMolecule struct {
StaticInput
}
type RolesDefaultsMain ¶
type RolesFiles ¶
type RolesFiles struct { StaticInput Resource scaffold.Resource }
type RolesHandlersMain ¶
type RolesMetaMain ¶
type RolesMetaMain struct { StaticInput Resource scaffold.Resource }
type RolesReadme ¶
type RolesReadme struct { StaticInput Resource scaffold.Resource }
type RolesTasksMain ¶
type RolesTemplates ¶
type RolesTemplates struct { StaticInput Resource scaffold.Resource }
type RolesVarsMain ¶
type StaticInput ¶
StaticInput is the input for scaffolding a static file with no parameters
func (*StaticInput) CustomRender ¶
func (s *StaticInput) CustomRender() ([]byte, error)
CustomRender return the template body unmodified
func (StaticInput) SetFS ¶
func (s StaticInput) SetFS(_ afero.Fs)
type Travis ¶
type Travis struct {
StaticInput
}
Source Files ¶
- ao_logs.go
- build_dockerfile.go
- build_test_framework_ansible_test_script.go
- build_test_framework_dockerfile.go
- constants.go
- deploy_operator.go
- dockerfilehybrid.go
- entrypoint.go
- go_mod.go
- input.go
- main.go
- molecule_default_asserts.go
- molecule_default_molecule.go
- molecule_default_playbook.go
- molecule_default_prepare.go
- molecule_test_cluster_molecule.go
- molecule_test_cluster_playbook.go
- molecule_test_local_molecule.go
- molecule_test_local_playbook.go
- molecule_test_local_prepare.go
- playbook.go
- roles_defaults_main.go
- roles_files.go
- roles_handlers_main.go
- roles_meta_main.go
- roles_readme.go
- roles_tasks_main.go
- roles_templates.go
- roles_vars_main.go
- travis.go
- usersetup.go
- watches.go