Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Removing references to spk #27

Merged
merged 3 commits into from
Apr 25, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ See operational changes at

### Added

- Enabled `spk ring` commands
- Enabled `bedrock ring` commands

### Changed

Expand All @@ -38,7 +38,7 @@ See operational changes at

### Added

- `spk setup` improvements
- `bedrock setup` improvements

### Changed

Expand All @@ -48,7 +48,7 @@ See operational changes at

### Added

- `spk setup` improvements
- `bedrock setup` improvements

### Changed

Expand All @@ -67,7 +67,7 @@ See operational changes at

### Added

- Initial version of `spk setup` command
- Initial version of `bedrock setup` command

### Changed

Expand All @@ -89,7 +89,7 @@ See operational changes at

### Changed

- Default fabrikate component initialized by `spk hld`
- Default fabrikate component initialized by `bedrock hld`
- Various bug fixes and refactoring

## [0.5.1] - 2020-02-05
Expand Down Expand Up @@ -117,7 +117,7 @@ See operational changes at
### Changed

- Resolved [bug](https://github.com/microsoft/bedrock/issues/916) around
`spk hld reconcile`
`bedrock hld reconcile`
- Resolved [bug](https://github.com/microsoft/bedrock/issues/905) around unit
test failure

Expand Down Expand Up @@ -169,18 +169,18 @@ See operational changes at

- Global Configuration

- One place to configuration all parameters to initialize the SPK tool
- One place to configuration all parameters to initialize the Bedrock tool

- Service Management

- The ability to create an Azure Repo (standard or mono-repo) with SPK
- The ability to create an Azure Repo (standard or mono-repo) with Bedrock
metadata files
- The ability to create a service in your Azure Repo that will automatically
be linked to an Azure DevOps Pipeline

- Service Introspection

- Features to able to see your services being deployed in the SPK CLI
- Features to able to see your services being deployed in the Bedrock CLI

### Known Issues

Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# SPK
# Bedrock CLI

[![Build Status](https://dev.azure.com/epicstuff/bedrock/_apis/build/status/microsoft.bedrock-cli?branchName=master)](https://dev.azure.com/epicstuff/bedrock/_build/latest?definitionId=2328&branchName=master)
![Azure DevOps coverage](https://img.shields.io/azure-devops/coverage/epicstuff/bedrock/2328/master)

`spk` helps you automate, manage, and observe Kubernetes deployment operations
based on [Bedrock](http://aka.ms/bedrock) patterns and principles.
`bedrock` helps you automate, manage, and observe Kubernetes deployment
operations based on [Bedrock](http://aka.ms/bedrock) patterns and principles.

Key features:

Expand All @@ -16,18 +16,18 @@ Key features:
3. Streamlines management of versioned Terraform environments
([learn more](./guides/infra/README.md#guides))

![spk diagram](./guides/images/spk.png)
![bedrock diagram](./guides/images/bedrock.png)

## Install

Download pre-compiled binaries of SPK on the
[release](https://github.com/microsoft/bedrock-cli/releases) page.
Download pre-compiled binaries of Bedrock CLI on the
[releases](https://github.com/microsoft/bedrock-cli/releases) page.

## CLI

```shell
$ spk
Usage: spk [options] [command]
$ bedrock
Usage: bedrock [options] [command]

The missing Bedrock CLI

Expand All @@ -37,7 +37,7 @@ Options:
-h, --help output usage information

Commands:
init|i [options] Initialize the spk tool for the first time.
init|i [options] Initialize the bedrock tool for the first time.
setup|s [options] An interactive command to setup resources in azure and azure dev-ops
deployment Introspect your deployments
hld Commands for initalizing and managing a bedrock HLD repository.
Expand All @@ -48,7 +48,7 @@ Commands:

## Prerequisites

To use `spk`, you must make sure you have the following tools installed:
To use `bedrock`, you must make sure you have the following tools installed:

- `git` - at _least_ version 2.22. Follow download instructions
[here](https://git-scm.com/downloads)
Expand All @@ -58,34 +58,34 @@ Follow instructions to download and install the rest of the prerequisites

## Getting Started

The fastest way to get started with `spk` is to following our interactive
The fastest way to get started with `bedrock` is to following our interactive
initialization.

```bash
spk init -i
bedrock init -i
```

This will guide you through the process of creating a configuration.
Alternatively if you already have a [configuration file](./guide/config-file.md)
you can run the command:

```bash
spk init -f spk-config.yaml
bedrock init -f bedrock-config.yaml
```

## Guides

You will find several guides to help you get started on each of the areas at
[SPK guides](./guides/README.md).
You will find several guides to help you get started on each of the CLI area
[here](./guides/README.md).

- [Managing a bedrock project with SPK](./guides/project-service-management-guide.md)
- [Observing deployments with SPK](./guides/service-introspection-onboarding.md)
- [Simplifying multiple Terraform environments with SPK](./guides/infra/README.md#guides)
- [Managing a project with the CLI](./guides/project-service-management-guide.md)
- [Observing deployments with the CLI](./guides/service-introspection-onboarding.md)
- [Simplifying multiple Terraform environments with the CLI](./guides/infra/README.md#guides)

## CLI Command Reference

> https://microsoft.github.io/bedrock-cli/commands/

## Contributing

[Contributing to spk](./guides/contributing.md).
[Contributing to bedrock](./guides/contributing.md).
6 changes: 3 additions & 3 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ steps:

- task: PublishPipelineArtifact@1
inputs:
path: $(System.DefaultWorkingDirectory)/dist/spk-linux
artifact: spk_linux_node_12
path: $(System.DefaultWorkingDirectory)/dist/bedrock-linux
artifact: bedrock_linux_node_12
condition: and(eq(variables['Agent.JobStatus'], 'Succeeded'), endsWith(variables['Agent.JobName'], 'node_12_x'))

- bash: |
Expand All @@ -90,7 +90,7 @@ steps:
coverageDeltaType: percentage
allowCoverageVariance: true
coverageVariance: $(COVERAGE_VARIANCE) # Prefer a value less 1.00
baseDefinitionId: $(SPK_DEFINITION_ID)
baseDefinitionId: $(BEDROCK_CLI_DEFINITION_ID)
baseBranchRef: refs/heads/master
runTitle: 'Code Coverage Evaluation'
condition: and(eq(variables['Agent.JobStatus'], 'Succeeded'), endsWith(variables['Agent.JobName'], 'node_12_x'))
6 changes: 3 additions & 3 deletions azure-pipelines/templates/create-github-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ jobs:
releaseNotesFilePath: ${{ parameters.releaseNotesFilePath }}
target: ${{ parameters.target }}
assets: |
$(Agent.BuildDirectory)/dist/spk-linux
$(Agent.BuildDirectory)/dist/spk-macos
$(Agent.BuildDirectory)/dist/spk-win.exe
$(Agent.BuildDirectory)/dist/bedrock-linux
$(Agent.BuildDirectory)/dist/bedrock-macos
$(Agent.BuildDirectory)/dist/bedrock-win.exe
tagSource: ${{ parameters.tagSource }}
isDraft: ${{ parameters.isDraft }}
isPreRelease: ${{ parameters.isPrelease }}
Expand Down
14 changes: 7 additions & 7 deletions azure-pipelines/templates/infra-generation-kv-pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pool:
vmImage: 'ubuntu-latest'

variables:
- group: 'spk-infra-hld-vg-kv'
- group: 'bedrock-infra-hld-vg-kv'

steps:
- checkout: self
Expand Down Expand Up @@ -35,15 +35,15 @@ steps:
- script: |
. build.sh --source-only
init
get_os_spk
get_spk_version
download_spk
get_os_bedrock
get_bedrock_version
download_bedrock
echo 'SPK Version: '
spk --version
bedrock --version
set -e
echo "GENERATING $(PROJECTDIRECTORY)"
cd $(PROJECTDIRECTORY)
spk infra generate -p $(CLUSTER)
bedrock infra generate -p $(CLUSTER)
env:
ARM_CLIENT_ID: $(ARMCLIENTID)
ARM_CLIENT_SECRET: $(ARMCLIENTSECRET)
Expand All @@ -62,7 +62,7 @@ steps:
. build.sh --source-only
init
cd $(PROJECTDIRECTORY)-generated/$(CLUSTER)
terraform plan -var-file=./spk.tfvars
terraform plan -var-file=./bedrock.tfvars
env:
ARM_CLIENT_ID: $(ARMCLIENTID)
ARM_CLIENT_SECRET: $(ARMCLIENTSECRET)
Expand Down
18 changes: 9 additions & 9 deletions azure-pipelines/templates/infra-generation-pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ pool:
vmImage: 'ubuntu-latest'

variables:
- group: 'spk-infra-hld-vg'
- group: 'bedrock-infra-hld-vg'

steps:
- checkout: self
Expand Down Expand Up @@ -35,21 +35,21 @@ steps:
- script: |
. build.sh --source-only
init
get_os_spk
get_spk_version
download_spk
echo 'SPK Version: '
spk --version
get_os_bedrock
get_bedrock_version
download_bedrock
echo 'Bedrock CLI Version: '
bedrock --version
set -e
echo "GENERATING $PROJECT_DIRECTORY"
cd $PROJECT_DIRECTORY
spk infra generate -p $CLUSTER
bedrock infra generate -p $CLUSTER
env:
ARM_CLIENT_ID: $(ARM_CLIENT_ID)
ARM_CLIENT_SECRET: $(ARM_CLIENT_SECRET)
ARM_TENANT_ID: $(ARM_TENANT_ID)
ARM_SUBSCRIPTION_ID: $(ARM_SUBSCRIPTION_ID)
displayName: 'SPK'
displayName: 'Bedrock CLI'

- script: |
. build.sh --source-only
Expand All @@ -62,7 +62,7 @@ steps:
. build.sh --source-only
init
cd $PROJECT_DIRECTORY-generated/$CLUSTER
terraform plan -var-file=./spk.tfvars
terraform plan -var-file=./bedrock.tfvars
env:
ARM_CLIENT_ID: $(ARM_CLIENT_ID)
ARM_CLIENT_SECRET: $(ARM_CLIENT_SECRET)
Expand Down
12 changes: 6 additions & 6 deletions spk-config.yaml → bedrock-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ azure_devops:
project: "" # Your AzDo project
infra:
# DO NOT MODIFY THE FOLLOWING
# Prerequisite versions are auto-generated upon executing `spk init`
# Prerequisite versions are auto-generated upon executing `bedrock init`
terraform: "v0.12.6"
helm: "v2.14.3"
git: "2.17.1"
Expand All @@ -19,13 +19,13 @@ introspection:
image: "mcr.microsoft.com/k8s/bedrock/spektate:latest" # Use this default docker image unless you would like to use a custom one
name: "spektate"
azure: # This is the storage account for the service introspection tool.
account_name: "storage-account-name" # Must be defined to run spk deployment commands
table_name: "storage-account-table-name" # Must be defined to run spk deployment commands
partition_key: "storage-account-table-partition-key" # Must be defined to run spk deployment commands
key: "storage-access-key" # Must be defined to run spk deployment commands. Use ${env:INTROSPECTION_STORAGE_ACCESS_KEY} and set it in .env file
account_name: "storage-account-name" # Must be defined to run bedrock deployment commands
table_name: "storage-account-table-name" # Must be defined to run bedrock deployment commands
partition_key: "storage-account-table-partition-key" # Must be defined to run bedrock deployment commands
key: "storage-access-key" # Must be defined to run bedrock deployment commands. Use ${env:INTROSPECTION_STORAGE_ACCESS_KEY} and set it in .env file
source_repo_access_token: "source_repo_access_token" # Optional. Required only when source repository is private (in order to render the author column in dashboard)

# Following 5 fields are needed only if using spk to onboard to use introspection tool
# Following 5 fields are needed only if using bedrock to onboard to use introspection tool
service_principal_id: "service-principal-id"
service_principal_secret: "service-principal-secret"
subscription_id: "subscription-id"
Expand Down
12 changes: 6 additions & 6 deletions docs/commands/spk.js → docs/commands/bedrock.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ var template =
var optionTemplate =
'<p>@@option@@</p><p class="cmd-description">@@description@@</p>@@inherit@@<div class="line-space"></div>';
var inheritTemplate =
'<p class="cmd-inherit">inherit @@inherit@@ from spk config.yaml</p>';
'<p class="cmd-inherit">inherit @@inherit@@ from bedrock config.yaml</p>';
var relTemplate =
'<li><a class="preserve-view button is-small has-border-none has-inner-focus has-flex-justify-content-start is-full-width has-text-wrap is-text-left">@@value@@</a></li>';

Expand Down Expand Up @@ -88,7 +88,7 @@ function populateVersionList() {
function showDetails(key) {
if (!key) {
window.location.hash = "#" + version + sepVersion;
$("#spk-details").html("");
$("#bedrock-details").html("");
return;
}
window.location.hash = version + sepVersion + key.replace(/\s/g, "_");
Expand All @@ -102,7 +102,7 @@ function showDetails(key) {
var alias = cmd.alias ? `|${cmd.alias}` : "";
var content = template.replace(
"@@main-cmd@@",
"spk " + key + alias + sanitize(values) + " [options]"
"bedrock " + key + alias + sanitize(values) + " [options]"
);
content = content.replace("@@cmd-description@@", cmd.description);

Expand Down Expand Up @@ -134,15 +134,15 @@ function showDetails(key) {
content =
'<p class="cmd-title1">@@main-cmd@@</p>'.replace(
"@@main-cmd@@",
"spk " + key
"bedrock " + key
) +
'<div class="markdown">' +
converter.makeHtml(cmd.markdown) +
"</div><hr>" +
content;
}

$("#spk-details").html(content);
$("#bedrock-details").html(content);
}

function populateListing() {
Expand All @@ -156,7 +156,7 @@ function populateListing() {
a +=
"<li><a href=\"javascript:showDetails('" +
c +
"');\">spk " +
"');\">bedrock " +
c +
"</a></li>";
return a;
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/change-rels.js
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ function getChangesHTML(oChanges) {
"@@changes@@",
oChanges.added
.map(function (add) {
return "<li>spk " + sanitize(add) + "</li>";
return "<li>bedrock " + sanitize(add) + "</li>";
})
.join("")
);
Expand All @@ -222,7 +222,7 @@ function getChangesHTML(oChanges) {
"@@changes@@",
oChanges.removed
.map(function (rm) {
return "<li>spk " + sanitize(rm) + "</li>";
return "<li>bedrock " + sanitize(rm) + "</li>";
})
.join("")
);
Expand Down
Loading