/* Copyright 2021 The KubeVela 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 cli import ( "context" "fmt" "net/http" "os" "os/exec" "os/signal" "path/filepath" "runtime" "strconv" "strings" "syscall" "time" "github.com/pkg/errors" "github.com/spf13/cobra" "github.com/oam-dev/kubevela/apis/types" "github.com/oam-dev/kubevela/pkg/utils/common" "github.com/oam-dev/kubevela/pkg/utils/system" cmdutil "github.com/oam-dev/kubevela/pkg/utils/util" "github.com/oam-dev/kubevela/references/docgen" ) const ( // SideBar file name for docsify SideBar = "_sidebar.md" // NavBar file name for docsify NavBar = "_navbar.md" // IndexHTML file name for docsify IndexHTML = "index.html" // CSS file name for custom CSS CSS = "custom.css" // README file name for docsify README = "README.md" ) const ( // Port is the port for reference docs website Port = ":18081" ) var ( webSite bool generateDocOnly bool showFormat string ) // getShowCommandType returns the appropriate command type based on context. // When order is empty (used under vela def), it returns TypeDefGeneration. // Otherwise, it returns TypeStart for the main vela command. func getShowCommandType(order string) string { if order == "" { return types.TypeDefGeneration } return types.TypeStart } // getShowCommandOrder returns the appropriate command order based on context. func getShowCommandOrder(order string) string { if order == "" { return "5" // Order within Code Generation group } return order } // NewCapabilityShowCommand shows the reference doc for a component type or trait func NewCapabilityShowCommand(c common.Args, order string, ioStreams cmdutil.IOStreams) *cobra.Command { var revision, path, location, i18nPath string cmd := &cobra.Command{ Use: "show", Short: "Show the reference doc for a component, trait, policy or workflow.", Long: "Show the reference doc for component, trait, policy or workflow types. 'vela show' equals with 'vela def show'. ", Example: `0. Run 'vela show' directly to start a web server for all reference docs. 1. Generate documentation for ComponentDefinition webservice: > vela show webservice -n vela-system 2. Generate documentation for local CUE Definition file webservice.cue: > vela show webservice.cue 3. Generate documentation for local Cloud Resource Definition YAML alibaba-vpc.yaml: > vela show alibaba-vpc.yaml 4. Specify output format, markdown supported: > vela show webservice --format markdown 5. Specify a language for output, by default, it's english. You can also load your own translation script: > vela show webservice --location zh > vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json 6. Show doc for a specified revision, it must exist in control plane cluster: > vela show webservice --revision v1 7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/ > vela show 8. Generate all docs and start a doc server > vela show --web `, RunE: func(cmd *cobra.Command, args []string) error { ctx := context.Background() var capabilityName string if len(args) > 0 { capabilityName = args[0] } else if !webSite { cmd.Println("generating all capability docs into folder '~/.vela/reference/docs/', use '--web' to start a server for browser.") generateDocOnly = true } namespace, err := GetFlagNamespace(cmd, c) if err != nil { return err } if namespace == "" { namespace, err = GetNamespaceFromEnv(cmd, c) if err != nil { return err } } var ver int if revision != "" { // v1, 1, both need to work version := strings.TrimPrefix(revision, "v") ver, err = strconv.Atoi(version) if err != nil { return fmt.Errorf("invalid revision: %w", err) } } if webSite || generateDocOnly { return startReferenceDocsSite(ctx, namespace, c, ioStreams, capabilityName) } if path != "" || showFormat == "md" || showFormat == "markdown" { return ShowReferenceMarkdown(ctx, c, ioStreams, capabilityName, path, location, i18nPath, namespace, int64(ver)) } return ShowReferenceConsole(ctx, c, ioStreams, capabilityName, namespace, location, i18nPath, int64(ver)) }, Annotations: map[string]string{ types.TagCommandType: getShowCommandType(order), types.TagCommandOrder: getShowCommandOrder(order), }, } cmd.Flags().BoolVarP(&webSite, "web", "", false, "start web doc site") cmd.Flags().StringVarP(&showFormat, "format", "", "", "specify format of output data, by default it's a pretty human readable format, you can specify markdown(md)") cmd.Flags().StringVarP(&revision, "revision", "r", "", "Get the specified revision of a definition. Use def get to list revisions.") cmd.Flags().StringVarP(&path, "path", "p", "", "Specify the path for of the doc generated from definition.") cmd.Flags().StringVarP(&location, "location", "l", "", "specify the location for of the doc generated from definition, now supported options 'zh', 'en'. ") cmd.Flags().StringVarP(&i18nPath, "i18n", "", "https://kubevela.io/reference-i18n.json", "specify the location for of the doc generated from definition, now supported options 'zh', 'en'. ") addNamespaceAndEnvArg(cmd) cmd.SetOut(ioStreams.Out) return cmd } func generateWebsiteDocs(capabilities []types.Capability, docsPath string) error { if err := generateSideBar(capabilities, docsPath); err != nil { return err } if err := generateNavBar(docsPath); err != nil { return err } if err := generateIndexHTML(docsPath); err != nil { return err } if err := generateCustomCSS(docsPath); err != nil { return err } return generateREADME(capabilities, docsPath) } func startReferenceDocsSite(ctx context.Context, ns string, c common.Args, ioStreams cmdutil.IOStreams, capabilityName string) error { home, err := system.GetVelaHomeDir() if err != nil { return err } referenceHome := filepath.Join(home, "reference") docsPath := filepath.Join(referenceHome, "docs") if _, err := os.Stat(docsPath); err != nil && os.IsNotExist(err) { if err := os.MkdirAll(docsPath, 0750); err != nil { return err } } capabilities, err := docgen.GetNamespacedCapabilitiesFromCluster(ctx, ns, c, nil) if err != nil { return err } // check whether input capability is valid var capabilityIsValid bool var capabilityType types.CapType for _, c := range capabilities { if capabilityName == "" { capabilityIsValid = true break } if c.Name == capabilityName { capabilityIsValid = true capabilityType = c.Type break } } if !capabilityIsValid { return fmt.Errorf("%s is not a valid component, trait, policy or workflow", capabilityName) } cli, err := c.GetClient() if err != nil { return err } ref := &docgen.MarkdownReference{ ParseReference: docgen.ParseReference{ Client: cli, I18N: &docgen.En, }, } if err := ref.CreateMarkdown(ctx, capabilities, docsPath, true); err != nil { return err } if err = generateWebsiteDocs(capabilities, docsPath); err != nil { return err } if generateDocOnly { return nil } if capabilityType != types.TypeWorkload && capabilityType != types.TypeTrait && capabilityType != types.TypeComponentDefinition && capabilityType != types.TypeWorkflowStep && capabilityType != "" { return fmt.Errorf("unsupported type: %v", capabilityType) } suffix := capabilityName if suffix != "" { suffix = "/" + suffix } url := fmt.Sprintf("http://127.0.0.1%s/#/%s%s", Port, capabilityType, suffix) server := &http.Server{ Addr: Port, Handler: http.FileServer(http.Dir(docsPath)), ReadTimeout: 5 * time.Second, WriteTimeout: 10 * time.Second, } server.SetKeepAlivesEnabled(true) errCh := make(chan error, 1) launch(server, errCh) select { case err = <-errCh: return err case <-time.After(time.Second): if err := OpenBrowser(url); err != nil { ioStreams.Infof("automatically invoking browser failed: %v\nPlease visit %s for reference docs", err, url) } } sc := make(chan os.Signal, 1) signal.Notify(sc, syscall.SIGTERM) <-sc ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() return server.Shutdown(ctx) } func launch(server *http.Server, errChan chan<- error) { go func() { err := server.ListenAndServe() if err != nil && errors.Is(err, http.ErrServerClosed) { errChan <- err } }() } func generateSideBar(capabilities []types.Capability, docsPath string) error { sideBar := filepath.Join(docsPath, SideBar) components, traits, workflowSteps, policies := getDefinitions(capabilities) f, err := os.Create(sideBar) // nolint if err != nil { return err } if _, err := f.WriteString("- Components Types\n"); err != nil { return err } for _, c := range components { if _, err := fmt.Fprintf(f, " - [%s](%s/%s.md)\n", c, types.TypeComponentDefinition, c); err != nil { return err } } if _, err := f.WriteString("- Traits\n"); err != nil { return err } for _, t := range traits { if _, err := fmt.Fprintf(f, " - [%s](%s/%s.md)\n", t, types.TypeTrait, t); err != nil { return err } } if _, err := f.WriteString("- Workflow Steps\n"); err != nil { return err } for _, t := range workflowSteps { if _, err := fmt.Fprintf(f, " - [%s](%s/%s.md)\n", t, types.TypeWorkflowStep, t); err != nil { return err } } if _, err := f.WriteString("- Policies\n"); err != nil { return err } for _, t := range policies { if _, err := fmt.Fprintf(f, " - [%s](%s/%s.md)\n", t, types.TypePolicy, t); err != nil { return err } } return nil } func generateNavBar(docsPath string) error { sideBar := filepath.Join(docsPath, NavBar) _, err := os.Create(sideBar) // nolint if err != nil { return err } return nil } func generateIndexHTML(docsPath string) error { indexHTML := `