import { ProjectOperationCredentials, RemoteRepoRef, RepoRef, ScmProviderType } from "@atomist/automation-client";
/**
 * Information needed to create a proper RemoteRepoRef for the
 * [[SdmPackK8sOptions.syncRepo]].  If `apiBase` and `providerType`
 * are not provided, cortex is queried to find the information.
 */
export interface SyncRepoRef extends RepoRef {
    /**
     * Root API URL.  Default is dependent on [[providerType]].  This
     * value is typically not set but rather looked up in cortex.
     */
    apiBase?: string;
    /**
     * If branch is provided, it is used.  If it is not provided,
     * things get complicated.  If the repo exists in the graph and it
     * has the defaultBranch property set, then the defaultBranch is
     * used.  If the repo does not exist in the graph or its
     * defaultBranch property is not set, "master" is used.  Since the
     * repo defaultBranch property could not be set initially but get
     * set at a later time, how sync repo behaves can change even if
     * the configuration does not.  Long story short, even though
     * branch is optional, set it if you want sync repo to behave
     * deterministically.
     */
    branch?: string;
    /**
     * Git SDM provider, e.g., "github_com".  Typically this value is
     * not set and looked up in cortex.
     */
    providerType?: ScmProviderType;
}
/**
 * Configuration options for sync mode operation.
 */
export interface SyncOptions {
    /**
     * To synchronize resources in k8s cluster with a Git repo,
     * provide a repo ref as the value of this property.  The value
     * can be either a SyncRepoRef or RemoteRepoRef.  On startup, the
     * contents of this repo ref will be synchronized with the
     * cluster, subsequent changes to this repo will be syncronized to
     * the cluster, and subsequent resource deployments will update
     * the contents of this repo.
     *
     * If a SyncRepoRef is provided, on startup cortex is queried to
     * find the details of the repo needed to create a RemoteRepoRef.
     * This RemoteRepoRef is created and then used as the value of
     * this property for the lifetime of the SDM.
     *
     * If a RemoteRepoRef is provided, it is used as is.
     */
    repo: SyncRepoRef | RemoteRepoRef;
    /**
     * Credentials to use when cloning the sync.repo.  These are
     * typically not provided in the SDM configuration, rather they
     * are are obtained during startup by the SDM via a cortex query.
     * If they are provided, the provided credentials are used rather
     * than any returned from cortex.
     */
    credentials?: ProjectOperationCredentials;
    /**
     * Key to use to encrypt Kubernetes Secret resource values before
     * storing them in the sync repo and decrypt them when reading
     * them from the sync repo.  If it is not provided, secrets are
     * not encrypted in the sync repo, so hopefully they aren't too
     * secret.
     *
     * You can use the bin/secret.js script bundled with this package
     * to manually encrypt and decrypt values using the same strategy.
     */
    secretKey?: string;
}
/**
 * Configuration options to be passed to the extension pack creation.
 */
export interface SdmPackK8sOptions {
    /**
     * Whether to add the undelete command.  Typically you would only
     * want to enable this in one SDM per workspace.  If no value is
     * provided, the comand is not added.
     */
    addCommands?: boolean;
    /**
     * Whether to register and converge a k8s cluster.  Typically this
     * is used from k8s-sdm to manage k8s cluster it is running in.
     */
    registerCluster?: boolean;
    /**
     * Synchronize resources in k8s cluster with a Git repo.
     */
    sync?: SyncOptions;
}
/** Validate the the partial SyncOptions contains a repo property. */
export declare function validSyncOptions(o: Partial<SyncOptions>): o is SyncOptions;