install

Documentation

Index

• Variables
• func TestScenarioValues() []string
• type ConfigValidator
• type Discoverer
• type FileFilterer
• type LicenseKeyFetcher
  • func NewServiceLicenseKeyFetcher(client recipes.NerdGraphClient) LicenseKeyFetcher
• type MockLicenseKeyFetcher
  • func NewMockLicenseKeyFetcher() *MockLicenseKeyFetcher
  • func (f *MockLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)
• type PacksFetcher
• type PacksInstaller
• type Prompter
• type RecipeFileFetcher
• type RecipeFilterRunner
• type RecipeInstallFunc
• type RecipeInstaller
  • func NewRecipeInstaller(ic types.InstallerContext, nrClient *newrelic.NewRelic) *RecipeInstaller
  • func (i *RecipeInstaller) Install() error
• type RecipeRepository
• type RecipeValidator
• type RecipeVarPreparer
• type ScenarioBuilder
  • func NewScenarioBuilder(ic types.InstallerContext) *ScenarioBuilder
  • func (b *ScenarioBuilder) Basic() *RecipeInstaller
  • func (b *ScenarioBuilder) BuildScenario(s TestScenario) *RecipeInstaller
  • func (b *ScenarioBuilder) ExecDiscovery() *RecipeInstaller
  • func (b *ScenarioBuilder) Fail() *RecipeInstaller
• type ServiceLicenseKeyFetcher
  • func (f *ServiceLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)
• type TestScenario

Variables

var Command = &cobra.Command{
	Use:   "install",
	Short: "Install New Relic.",
	Run: func(cmd *cobra.Command, args []string) {
		ic := types.InstallerContext{
			AssumeYes:          assumeYes,
			LocalRecipes:       localRecipes,
			RecipeNames:        recipeNames,
			RecipePaths:        recipePaths,
			SkipIntegrations:   skipIntegrations,
			SkipLoggingInstall: skipLoggingInstall,
			SkipApm:            skipApm,
			SkipInfraInstall:   skipInfra,
		}

		config.InitFileLogger()

		client.WithClientAndProfile(func(nrClient *newrelic.NewRelic, profile *credentials.Profile) {
			if trace {
				log.SetLevel(log.TraceLevel)
				nrClient.SetLogLevel("trace")
			} else if debug {
				log.SetLevel(log.DebugLevel)
				nrClient.SetLogLevel("debug")
			}

			err := assertProfileIsValid(profile)
			if err != nil {
				log.Fatal(err)
			}

			i := NewRecipeInstaller(ic, nrClient)

			if err := i.Install(); err != nil {
				if err == types.ErrInterrupt {
					return
				}

				log.Fatalf("We encountered an error during the installation: %s. If this problem persists please visit the documentation and support page for additional help here: https://one.newrelic.com/-/06vjAeZLKjP", err)
			}
		})
	},
}

Command represents the install command.

var TestCommand = &cobra.Command{
	Use:    "installTest",
	Short:  "Run a UX test of the install command.",
	Hidden: true,
	Run: func(cmd *cobra.Command, args []string) {
		ic := types.InstallerContext{
			RecipePaths:        recipePaths,
			RecipeNames:        recipeNames,
			SkipIntegrations:   skipIntegrations,
			SkipLoggingInstall: skipLoggingInstall,
			SkipApm:            skipApm,
			AssumeYes:          assumeYes,
		}

		b := NewScenarioBuilder(ic)
		i := b.BuildScenario(TestScenario(testScenario))

		if i == nil {
			log.Fatalf("Scenario %s is not valid.  Valid values are %s", testScenario, strings.Join(TestScenarioValues(), ","))
		}

		if trace {
			log.SetLevel(log.TraceLevel)
		} else if debug {
			log.SetLevel(log.DebugLevel)
		}

		if err := i.Install(); err != nil {
			if err == types.ErrInterrupt {
				return
			}

			log.Fatalf("test failed: %s", err)
		}
	},
}

TestCommand represents the test command for the install command.

var (
	TestScenarios = []TestScenario{
		Basic,
		Fail,
	}
)

Functions

func TestScenarioValues

func TestScenarioValues() []string

Types

type ConfigValidator

type ConfigValidator interface {
	Validate(ctx context.Context) error
}

type Discoverer

type Discoverer interface {
	Discover(context.Context) (*types.DiscoveryManifest, error)
}

Discoverer is responsible for discovering informataion about the host system.

type FileFilterer

type FileFilterer interface {
	Filter(context.Context, []types.OpenInstallationRecipe) ([]types.OpenInstallationLogMatch, error)
}

FileFilterer determines the existence of files on the underlying filesystem.

type LicenseKeyFetcher

type LicenseKeyFetcher interface {
	FetchLicenseKey(context.Context) (string, error)
}

func NewServiceLicenseKeyFetcher

func NewServiceLicenseKeyFetcher(client recipes.NerdGraphClient) LicenseKeyFetcher

type MockLicenseKeyFetcher

type MockLicenseKeyFetcher struct {
	FetchLicenseKeyFunc func(ctx context.Context) (string, error)
}

func NewMockLicenseKeyFetcher

func NewMockLicenseKeyFetcher() *MockLicenseKeyFetcher

func (*MockLicenseKeyFetcher) FetchLicenseKey

func (f *MockLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)

type PacksFetcher

type PacksFetcher interface {
	FetchPacks(context.Context, []types.OpenInstallationRecipe) ([]types.OpenInstallationObservabilityPack, error)
}

type PacksInstaller

type PacksInstaller interface {
	Install(ctx context.Context, packs []types.OpenInstallationObservabilityPack) error
}

type Prompter

type Prompter interface {
	PromptYesNo(msg string) (bool, error)
	MultiSelect(msg string, options []string) ([]string, error)
}

type RecipeFileFetcher

type RecipeFileFetcher interface {
	FetchRecipeFile(recipeURL *url.URL) (*types.OpenInstallationRecipe, error)
	LoadRecipeFile(filename string) (*types.OpenInstallationRecipe, error)
}

type RecipeFilterRunner

type RecipeFilterRunner interface {
	RunFilterAll(ctx context.Context, r []types.OpenInstallationRecipe, m *types.DiscoveryManifest) []types.OpenInstallationRecipe
	EnsureDoesNotFilter(ctx context.Context, r []types.OpenInstallationRecipe, m *types.DiscoveryManifest) error
}

type RecipeInstallFunc

type RecipeInstallFunc func(ctx context.Context, i *RecipeInstaller, m *types.DiscoveryManifest, r *types.OpenInstallationRecipe, recipes []types.OpenInstallationRecipe) error

type RecipeInstaller

type RecipeInstaller struct {
	types.InstallerContext
	// contains filtered or unexported fields
}

func NewRecipeInstaller

func NewRecipeInstaller(ic types.InstallerContext, nrClient *newrelic.NewRelic) *RecipeInstaller

func (*RecipeInstaller) Install

func (i *RecipeInstaller) Install() error

type RecipeRepository

type RecipeRepository interface {
	FindAll(m types.DiscoveryManifest) []types.OpenInstallationRecipe
}

type RecipeValidator

type RecipeValidator interface {
	ValidateRecipe(context.Context, types.DiscoveryManifest, types.OpenInstallationRecipe) (entityGUID string, err error)
}

RecipeValidator validates installation of a recipe.

type RecipeVarPreparer

type RecipeVarPreparer interface {
	Prepare(m types.DiscoveryManifest, r types.OpenInstallationRecipe, assumeYes bool, licenseKey string) (types.RecipeVars, error)
}

type ScenarioBuilder

type ScenarioBuilder struct {
	// contains filtered or unexported fields
}

func NewScenarioBuilder

func NewScenarioBuilder(ic types.InstallerContext) *ScenarioBuilder

func (*ScenarioBuilder) Basic

func (b *ScenarioBuilder) Basic() *RecipeInstaller

func (*ScenarioBuilder) BuildScenario

func (b *ScenarioBuilder) BuildScenario(s TestScenario) *RecipeInstaller

func (*ScenarioBuilder) ExecDiscovery

func (b *ScenarioBuilder) ExecDiscovery() *RecipeInstaller

func (*ScenarioBuilder) Fail

func (b *ScenarioBuilder) Fail() *RecipeInstaller

type ServiceLicenseKeyFetcher

type ServiceLicenseKeyFetcher struct {
	// contains filtered or unexported fields
}

relies on the Nerdgraph service

func (*ServiceLicenseKeyFetcher) FetchLicenseKey

func (f *ServiceLicenseKeyFetcher) FetchLicenseKey(ctx context.Context) (string, error)

type TestScenario

type TestScenario string

const (
	Basic         TestScenario = "BASIC"
	Fail          TestScenario = "FAIL"
	ExecDiscovery TestScenario = "EXEC_DISCOVERY"
)