istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/url/url.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package url
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"istio.io/istio/operator/version"
    21  )
    22  
    23  var (
    24  	v           = version.OperatorBinaryVersion
    25  	baseVersion = v.MinorVersion.String()
    26  )
    27  
    28  // istio.io related URLs
    29  var (
    30  	// BaseURL for istio.io
    31  	BaseURL = "https://istio.io/"
    32  
    33  	// DocsVersion is a documentation version for istio.io
    34  	// This will build version as v1.6, v1.7, v1.8
    35  	DocsVersion = fmt.Sprintf("%s%s", "v", baseVersion)
    36  
    37  	// DocsURL is a base docs URL for istio.io
    38  	DocsURL = fmt.Sprintf("%s%s%s", BaseURL, DocsVersion, "/docs/")
    39  
    40  	// #####################################
    41  	// Operations related URLs for istio.io
    42  	// #####################################
    43  
    44  	// OpsURL is a base URL for operations related docs
    45  	OpsURL = fmt.Sprintf("%s%s", DocsURL, "ops/")
    46  
    47  	// DeploymentRequirements should generate
    48  	// https://istio.io/v1.7/docs/ops/deployment/requirements/
    49  	DeploymentRequirements = fmt.Sprintf("%s%s", OpsURL, "deployment/requirements/")
    50  
    51  	// ProtocolSelection should generate
    52  	// https://istio.io/v1.15/docs/ops/configuration/traffic-management/protocol-selection/
    53  	ProtocolSelection = fmt.Sprintf("%s%s", OpsURL, "configuration/traffic-management/protocol-selection/")
    54  
    55  	// #####################################
    56  	// Reference related URLs for istio.io
    57  	// #####################################
    58  
    59  	// ReferenceURL is a base URL for reference related docs
    60  	ReferenceURL = fmt.Sprintf("%s%s", DocsURL, "reference/")
    61  
    62  	// IstioOperatorSpec should generate
    63  	// https://istio.io/v1.7/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec
    64  	IstioOperatorSpec = fmt.Sprintf("%s%s", ReferenceURL, "config/istio.operator.v1alpha1/#IstioOperatorSpec")
    65  
    66  	// ConfigAnalysis should generate
    67  	// https://istio.io/v1.7/docs/reference/config/analysis
    68  	ConfigAnalysis = fmt.Sprintf("%s%s", ReferenceURL, "config/analysis")
    69  )