Add --spec to package command (#1411)

This commit is contained in:
Ta-Ching Chen
2019-11-18 11:15:48 +08:00
committed by GitHub
parent f8e98f9f14
commit 66b9dfa8e9
9 changed files with 238 additions and 73 deletions
+2 -2
View File
@@ -37,7 +37,7 @@ func Commands() *cobra.Command {
flag.FnSpecializationTimeout, flag.FnExecutionTimeout,
// TODO retired pkg related flag from function cmd
flag.FnCode, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.PkgCode, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.HtUrl, flag.HtMethod,
// flag for newdeploy to use.
@@ -83,7 +83,7 @@ func Commands() *cobra.Command {
flag.FnExecutorType, flag.FnSecret, flag.FnCfgMap,
flag.FnSpecializationTimeout, flag.FnExecutionTimeout,
flag.FnCode, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.PkgCode, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.FnBuildCmd, flag.PkgForce,
flag.RunTimeMinCPU, flag.RunTimeMaxCPU, flag.RunTimeMinMemory,
+32 -10
View File
@@ -116,16 +116,38 @@ func (opts *CreateSubCommand) complete(input cli.Input) error {
var pkgMetadata *metav1.ObjectMeta
var envName string
if len(pkgName) > 0 {
// use existing package
pkg, err := opts.client.PackageGet(&metav1.ObjectMeta{
Namespace: fnNamespace,
Name: pkgName,
})
if err != nil {
return errors.Wrap(err, fmt.Sprintf("read package in '%v' in Namespace: %s. Package needs to be present in the same namespace as function", pkgName, fnNamespace))
var pkg *fv1.Package
if toSpec {
fr, err := spec.ReadSpecs(specDir)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("error reading spec in '%v'", specDir))
}
obj := fr.SpecExists(&fv1.Package{
Metadata: metav1.ObjectMeta{
Name: pkgName,
Namespace: fnNamespace,
},
}, true, false)
if obj == nil {
return errors.Errorf("please create package %v spec file before referencing it", pkgName)
}
pkg = obj.(*fv1.Package)
pkgMetadata = &pkg.Metadata
} else {
// use existing package
pkg, err = opts.client.PackageGet(&metav1.ObjectMeta{
Namespace: fnNamespace,
Name: pkgName,
})
if err != nil {
return errors.Wrap(err, fmt.Sprintf("read package in '%v' in Namespace: %s. Package needs to be present in the same namespace as function", pkgName, fnNamespace))
}
pkgMetadata = &pkg.Metadata
}
pkgMetadata = &pkg.Metadata
envName = pkg.Spec.Environment.Name
if envName != input.String(flagkey.FnEnvironmentName) {
console.Warn("Function's environment is different than package's environment, package's environment will be used for creating function")
@@ -156,11 +178,11 @@ func (opts *CreateSubCommand) complete(input cli.Input) error {
srcArchiveFiles := input.StringSlice(flagkey.PkgSrcArchive)
var deployArchiveFiles []string
noZip := false
code := input.String(flagkey.FnCode)
code := input.String(flagkey.PkgCode)
if len(code) == 0 {
deployArchiveFiles = input.StringSlice(flagkey.PkgDeployArchive)
} else {
deployArchiveFiles = append(deployArchiveFiles, input.String(flagkey.FnCode))
deployArchiveFiles = append(deployArchiveFiles, input.String(flagkey.PkgCode))
noZip = true
}
// return error when both src & deploy archive are empty
+2 -2
View File
@@ -84,11 +84,11 @@ func (opts *UpdateSubCommand) complete(input cli.Input) error {
var deployArchiveFiles []string
codeFlag := false
code := input.String(flagkey.FnCode)
code := input.String(flagkey.PkgCode)
if len(code) == 0 {
deployArchiveFiles = input.StringSlice(flagkey.PkgDeployArchive)
} else {
deployArchiveFiles = append(deployArchiveFiles, input.String(flagkey.FnCode))
deployArchiveFiles = append(deployArchiveFiles, input.String(flagkey.PkgCode))
codeFlag = true
}
+2 -2
View File
@@ -31,8 +31,8 @@ func Commands() *cobra.Command {
}
wrapper.SetFlags(createCmd, flag.FlagSet{
Required: []flag.Flag{flag.PkgEnvironment},
Optional: []flag.Flag{flag.PkgName, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.PkgBuildCmd, flag.NamespacePackage, flag.NamespaceEnvironment},
Optional: []flag.Flag{flag.PkgName, flag.PkgCode, flag.PkgSrcArchive, flag.PkgDeployArchive,
flag.PkgBuildCmd, flag.NamespacePackage, flag.NamespaceEnvironment, flag.SpecSave},
})
getSrcCmd := &cobra.Command{
+29 -7
View File
@@ -62,7 +62,11 @@ func (opts *CreateSubCommand) do(input cli.Input) error {
func (opts *CreateSubCommand) run(input cli.Input) error {
pkgName := input.String(flagkey.PkgName)
if len(pkgName) == 0 {
console.Warn(fmt.Sprintf("--%v will be soon marked as required flag, see 'help' for details", flagkey.HtName))
if input.Bool(flagkey.SpecSave) && len(input.String(flagkey.PkgName)) == 0 {
return errors.Errorf("--%v is necessary when creating spec file", flagkey.PkgName)
} else {
console.Warn(fmt.Sprintf("--%v will be soon marked as required flag, see 'help' for details", flagkey.HtName))
}
}
pkgNamespace := input.String(flagkey.NamespacePackage)
envName := input.String(flagkey.PkgEnvironment)
@@ -71,12 +75,27 @@ func (opts *CreateSubCommand) run(input cli.Input) error {
deployArchiveFiles := input.StringSlice(flagkey.PkgDeployArchive)
buildcmd := input.String(flagkey.PkgBuildCmd)
noZip := false
code := input.String(flagkey.PkgCode)
if len(code) == 0 {
deployArchiveFiles = input.StringSlice(flagkey.PkgDeployArchive)
} else {
deployArchiveFiles = append(deployArchiveFiles, input.String(flagkey.PkgCode))
noZip = true
}
if len(srcArchiveFiles) == 0 && len(deployArchiveFiles) == 0 {
return errors.Errorf("need --%v or --%v flag", flagkey.PkgSrcArchive, flagkey.PkgDeployArchive)
return errors.Errorf("need --%v or --%v or --%v argument", flagkey.PkgCode, flagkey.PkgSrcArchive, flagkey.PkgDeployArchive)
}
var specDir, specFile string
if input.Bool(flagkey.SpecSave) {
specDir = util.GetSpecDir(input)
specFile = fmt.Sprintf("package-%v.yaml", pkgName)
}
_, err := CreatePackage(input, opts.client, pkgName, pkgNamespace, envName, envNamespace,
srcArchiveFiles, deployArchiveFiles, buildcmd, "", "", false)
srcArchiveFiles, deployArchiveFiles, buildcmd, specDir, specFile, noZip)
return err
}
@@ -138,14 +157,17 @@ func CreatePackage(input cli.Input, client *client.Client, pkgName string, pkgNa
}
if len(specFile) > 0 {
// if a package sith the same spec exists, don't create a new spec file
// if a package with the same spec exists, don't create a new spec file
fr, err := spec.ReadSpecs(util.GetSpecDir(input))
if err != nil {
return nil, errors.Wrap(err, "error reading specs")
}
if m := fr.SpecExists(pkg, false, true); m != nil {
fmt.Printf("Re-using previously created package %v\n", m.Name)
return m, nil
obj := fr.SpecExists(pkg, true, true)
if obj != nil {
pkg := obj.(*fv1.Package)
fmt.Printf("Re-using previously created package %v\n", pkg.Metadata.Name)
return &pkg.Metadata, nil
}
err = spec.SpecSave(*pkg, specFile)
+32 -4
View File
@@ -21,6 +21,7 @@ import (
"fmt"
"os"
"path/filepath"
"strings"
"github.com/dchest/uniuri"
"github.com/hashicorp/go-multierror"
@@ -41,6 +42,17 @@ import (
// upload the archive using client. noZip avoids zipping the
// includeFiles, but is ignored if there's more than one includeFile.
func CreateArchive(client *client.Client, includeFiles []string, noZip bool, specDir string, specFile string) (*fv1.Archive, error) {
// get root dir
var rootDir string
var err error
if len(specFile) > 0 {
rootDir, err = filepath.Abs(specDir + "/..")
if err != nil {
return nil, errors.Wrapf(err, "error getting root directory of spec directory")
}
}
errs := utils.MultiErrorWithFormat()
fileURL := ""
@@ -57,9 +69,22 @@ func CreateArchive(client *client.Client, includeFiles []string, noZip bool, spe
}
// Get files from inputs as number of files decide next steps
absPath, err := filepath.Abs(path)
if err != nil {
errs = multierror.Append(errs, errors.Wrapf(err, "error converting path to the absolute path \"%v\"", path))
continue
}
if !strings.HasPrefix(absPath, rootDir) {
errs = multierror.Append(errs, errors.Errorf("The files (%v) should be put under the same parent directory (%v) of spec directory; otherwise, the archive will be empty when applying spec files", path, rootDir))
continue
}
path := filepath.Join(rootDir, path)
files, err := utils.FindAllGlobs([]string{path})
if err != nil {
return nil, errors.Wrap(err, "error finding all globs")
errs = multierror.Append(errs, errors.Wrap(err, "error finding all globs"))
continue
}
if len(files) == 0 {
@@ -89,9 +114,12 @@ func CreateArchive(client *client.Client, includeFiles []string, noZip bool, spe
if err != nil {
return nil, errors.Wrap(err, "error reading specs")
}
if m := fr.SpecExists(aus, false, true); m != nil {
fmt.Printf("Re-using previously created archive %v\n", m.Name)
aus.Name = m.Name
obj := fr.SpecExists(aus, true, true)
if obj != nil {
oldAus := obj.(*spectypes.ArchiveUploadSpec)
fmt.Printf("Re-using previously created archive %v\n", oldAus.Name)
aus.Name = oldAus.Name
} else {
// save the uploadspec
err := spec.SpecSave(*aus, specFile)
+135 -42
View File
@@ -34,13 +34,9 @@ import (
"github.com/fission/fission/pkg/fission-cli/cmd/spec/types"
"github.com/fission/fission/pkg/fission-cli/console"
"github.com/fission/fission/pkg/fission-cli/util"
"github.com/fission/fission/pkg/generator/encoder"
v1generator "github.com/fission/fission/pkg/generator/v1"
"github.com/fission/fission/pkg/utils"
)
var specDefaultEncoder = encoder.DefaultYAMLEncoder()
const (
FISSION_DEPLOYMENT_NAME_KEY = "fission-name"
FISSION_DEPLOYMENT_UID_KEY = "fission-uid"
@@ -129,8 +125,8 @@ func MapKey(m *metav1.ObjectMeta) string {
return fmt.Sprintf("%v:%v", m.Namespace, m.Name)
}
// Save saves object encoded value to spec file under given spec directory
func Save(data []byte, specDir string, specFile string) error {
// save saves object encoded value to spec file under given spec directory
func save(data []byte, specDir string, specFile string) error {
// verify
if _, err := os.Stat(filepath.Join(specDir, "fission-deployment-config.yaml")); os.IsNotExist(err) {
return errors.Wrap(err, "Couldn't find specs, run `fission spec init` first")
@@ -168,6 +164,7 @@ func Save(data []byte, specDir string, specFile string) error {
// called from `fission * create --spec`
func SpecSave(resource interface{}, specFile string) error {
var meta metav1.ObjectMeta
specDir := "specs"
// make sure we're writing a known type
@@ -177,38 +174,44 @@ func SpecSave(resource interface{}, specFile string) error {
case types.ArchiveUploadSpec:
typedres.Kind = "ArchiveUploadSpec"
data, err = yaml.Marshal(typedres)
meta = metav1.ObjectMeta{
Name: typedres.Name,
}
case fv1.Package:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "Package"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.Function:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "Function"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.Environment:
env := resource.(fv1.Environment)
var generator *v1generator.EnvironmentGenerator
generator, err = v1generator.CreateEnvironmentGeneratorFromObj(&env)
if err != nil {
return err
}
data, err = generator.StructuredGenerate(specDefaultEncoder)
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "Environment"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.HTTPTrigger:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "HTTPTrigger"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.KubernetesWatchTrigger:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "KubernetesWatchTrigger"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.MessageQueueTrigger:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "MessageQueueTrigger"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
case fv1.TimeTrigger:
typedres.TypeMeta.APIVersion = fv1.CRD_VERSION
typedres.TypeMeta.Kind = "TimeTrigger"
data, err = yaml.Marshal(typedres)
meta = typedres.Metadata
default:
return fmt.Errorf("can't save resource %#v", resource)
}
@@ -216,7 +219,28 @@ func SpecSave(resource interface{}, specFile string) error {
return errors.Wrap(err, "Couldn't marshal YAML")
}
return Save(data, specDir, specFile)
fr, err := ReadSpecs(specDir)
if err != nil {
return errors.Wrap(err, fmt.Sprintf("error reading spec in '%v'", specDir))
}
exists, err := fr.existsInSpecs(resource)
if err != nil {
return err
}
if exists {
return errors.Errorf("same name resource (%v) already exists in namespace (%v)", meta.Name, meta.Namespace)
}
err = save(data, specDir, specFile)
if err != nil {
return err
}
console.Info(fmt.Sprintf("Saving %v/%v to %v", meta.Namespace, meta.Name, specFile))
return nil
}
// validateFunctionReference checks a function reference
@@ -263,32 +287,36 @@ func (fr *FissionResources) Validate(input cli.Input) error {
for _, p := range fr.Packages {
packages[MapKey(&p.Metadata)] = false
// check archive refs from package
aname := strings.TrimPrefix(p.Spec.Source.URL, ARCHIVE_URL_PREFIX)
if len(aname) > 0 {
if _, ok := archives[aname]; !ok {
result = multierror.Append(result, fmt.Errorf(
"%v: package '%v' references unknown source archive %v%v",
fr.SourceMap.Locations["Package"][p.Metadata.Namespace][p.Metadata.Name],
p.Metadata.Name,
ARCHIVE_URL_PREFIX,
aname))
} else {
archives[aname] = true
if strings.HasPrefix(p.Spec.Deployment.URL, ARCHIVE_URL_PREFIX) {
// check archive refs from package
aname := strings.TrimPrefix(p.Spec.Source.URL, ARCHIVE_URL_PREFIX)
if len(aname) > 0 {
if _, ok := archives[aname]; !ok {
result = multierror.Append(result, fmt.Errorf(
"%v: package '%v' references unknown source archive %v%v",
fr.SourceMap.Locations["Package"][p.Metadata.Namespace][p.Metadata.Name],
p.Metadata.Name,
ARCHIVE_URL_PREFIX,
aname))
} else {
archives[aname] = true
}
}
}
aname = strings.TrimPrefix(p.Spec.Deployment.URL, ARCHIVE_URL_PREFIX)
if len(aname) > 0 {
if _, ok := archives[aname]; !ok {
result = multierror.Append(result, fmt.Errorf(
"%v: package '%v' references unknown deployment archive %v%v",
fr.SourceMap.Locations["Package"][p.Metadata.Namespace][p.Metadata.Name],
p.Metadata.Name,
ARCHIVE_URL_PREFIX,
aname))
} else {
archives[aname] = true
if strings.HasPrefix(p.Spec.Deployment.URL, ARCHIVE_URL_PREFIX) {
aname := strings.TrimPrefix(p.Spec.Deployment.URL, ARCHIVE_URL_PREFIX)
if len(aname) > 0 {
if _, ok := archives[aname]; !ok {
result = multierror.Append(result, fmt.Errorf(
"%v: package '%v' references unknown deployment archive %v%v",
fr.SourceMap.Locations["Package"][p.Metadata.Namespace][p.Metadata.Name],
p.Metadata.Name,
ARCHIVE_URL_PREFIX,
aname))
} else {
archives[aname] = true
}
}
}
@@ -377,7 +405,7 @@ func (fr *FissionResources) Validate(input cli.Input) error {
ks := strings.Split(key, ":")
namespace, name := ks[0], ks[1]
if !referenced {
result = multierror.Append(result, fmt.Errorf(
console.Warn(fmt.Sprintf(
"%v: package '%v' is not used in any function",
fr.SourceMap.Locations["Package"][namespace][name],
name))
@@ -431,7 +459,7 @@ func (fr *FissionResources) Validate(input cli.Input) error {
}
// Unlike CLI can change the environment version silently,
// we have to warn the user to modify spec file when this takes place.
if e.Spec.Version < 3 && e.Spec.Poolsize != 0 {
if e.Spec.Poolsize != 3 && e.Spec.Version < 3 {
console.Warn("Poolsize can only be configured when environment version equals to 3, default poolsize 3 will be used for creating environment pool.")
}
}
@@ -591,7 +619,8 @@ func (fr *FissionResources) ParseYaml(b []byte, loc *Location) error {
// Returns metadata if the given resource exists in the specs, nil
// otherwise. compareMetadata and compareSpec control how the
// equality check is performed.
func (fr *FissionResources) SpecExists(resource interface{}, compareMetadata bool, compareSpec bool) *metav1.ObjectMeta {
// TODO: deprecated SpecExists
func (fr *FissionResources) SpecExists(resource interface{}, compareMetadata bool, compareSpec bool) interface{} {
switch typedres := resource.(type) {
case *types.ArchiveUploadSpec:
for _, aus := range fr.ArchiveUploadSpecs {
@@ -604,7 +633,7 @@ func (fr *FissionResources) SpecExists(resource interface{}, compareMetadata boo
reflect.DeepEqual(aus.ExcludeGlobs, typedres.ExcludeGlobs)) {
continue
}
return &metav1.ObjectMeta{Name: aus.Name}
return &aus
}
return nil
case *fv1.Package:
@@ -615,7 +644,7 @@ func (fr *FissionResources) SpecExists(resource interface{}, compareMetadata boo
if compareSpec && !reflect.DeepEqual(p.Spec, typedres.Spec) {
continue
}
return &p.Metadata
return &p
}
return nil
@@ -625,6 +654,70 @@ func (fr *FissionResources) SpecExists(resource interface{}, compareMetadata boo
}
}
func (fr *FissionResources) existsInSpecs(resource interface{}) (bool, error) {
switch typedres := resource.(type) {
case types.ArchiveUploadSpec:
for _, obj := range fr.ArchiveUploadSpecs {
if obj.Name == typedres.Name {
return true, nil
}
}
case fv1.Package:
for _, obj := range fr.Packages {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.Function:
for _, obj := range fr.Functions {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.Environment:
for _, obj := range fr.Environments {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.HTTPTrigger:
for _, obj := range fr.HttpTriggers {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.KubernetesWatchTrigger:
for _, obj := range fr.KubernetesWatchTriggers {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.MessageQueueTrigger:
for _, obj := range fr.MessageQueueTriggers {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
case fv1.TimeTrigger:
for _, obj := range fr.TimeTriggers {
if obj.Metadata.Name == typedres.Metadata.Name &&
obj.Metadata.Namespace == typedres.Metadata.Namespace {
return true, nil
}
}
default:
return false, fmt.Errorf("unknown resource type %#v", typedres)
}
return false, nil
}
func (loc Location) String() string {
return fmt.Sprintf("%v:%v", loc.Path, loc.Line)
}