Hercules.Effect

Documentation

parseDrvSecretsMap :: Map ByteString ByteString -> Either Text (Map Text SecretRef)

parseSecretRefs :: Text -> Object -> Either Text (Map Text SecretRef)

parseSecretRef :: Text -> Value -> Either Text SecretRef

writeSecrets

Arguments

:: (MonadIO m, KatipContext m)

=> Bool

Whether we're in a friendly context, such as the CLI.

-> Maybe SecretContext

-> Maybe FilePath

Optional source file

-> Map Text SecretRef

Declared secrets from the effect derivation

-> Map Text (Sensitive Secret)

Local secrets

-> Map Text (Sensitive (Map Text Value))

Server secrets

-> FilePath

-> m ()

Write secrets to file based on secretsMap value

data RunEffectParams

Constructors

RunEffectParams

Fields

• runEffectDerivation :: Derivation
• runEffectToken :: Maybe (Sensitive Text)
• runEffectSecretsConfigPath :: Maybe FilePath
• runEffectSecretContext :: Maybe SecretContext
• runEffectServerSecrets :: Sensitive (Map Text (Map Text Value))
• runEffectApiBaseURL :: Text
• runEffectDir :: FilePath
• runEffectProjectId :: Maybe (Id "project")
• runEffectProjectPath :: Maybe Text
• runEffectUseNixDaemonProxy :: Bool
• runEffectExtraNixOptions :: [(Text, Text)]
• runEffectFriendly :: Bool

  Whether we can relax security in favor of usability; True in hci effect run. False in agent.

(=:) :: k -> a -> Map k a

runEffect :: (MonadThrow m, KatipContext m) => RunEffectParams -> m ExitCode

withNixDaemonProxy :: [(Text, Text)] -> FilePath -> IO a -> IO a