Skip to content

Commit

Permalink
Update all links (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
majst01 authored Oct 18, 2023
1 parent 69f5639 commit 940ffb8
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 78 deletions.
98 changes: 50 additions & 48 deletions docs/Manifest.toml
Original file line number Diff line number Diff line change
@@ -1,234 +1,236 @@
# This file is machine-generated - editing it directly is not advised

[[ANSIColoredPrinters]]
manifest_format = "2.0"

[[deps.ANSIColoredPrinters]]
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9"
version = "0.0.1"

[[Artifacts]]
[[deps.Artifacts]]
uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"

[[Base64]]
[[deps.Base64]]
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

[[BitFlags]]
[[deps.BitFlags]]
git-tree-sha1 = "43b1a4a8f797c1cddadf60499a8a077d4af2cd2d"
uuid = "d1d4a3ce-64b1-5f1a-9ba4-7e7e69966f35"
version = "0.1.7"

[[CodecZlib]]
[[deps.CodecZlib]]
deps = ["TranscodingStreams", "Zlib_jll"]
git-tree-sha1 = "02aa26a4cf76381be7f66e020a3eddeb27b0a092"
uuid = "944b1d66-785c-5afd-91f1-9de20f533193"
version = "0.7.2"

[[ConcurrentUtilities]]
[[deps.ConcurrentUtilities]]
deps = ["Serialization", "Sockets"]
git-tree-sha1 = "5372dbbf8f0bdb8c700db5367132925c0771ef7e"
uuid = "f0e56b4a-5159-44fe-b623-3e5288b988bb"
version = "2.2.1"

[[Dates]]
[[deps.Dates]]
deps = ["Printf"]
uuid = "ade2ca70-3891-5945-98fb-dc099432e06a"

[[DocStringExtensions]]
[[deps.DocStringExtensions]]
deps = ["LibGit2"]
git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d"
uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
version = "0.9.3"

[[Docs]]
[[deps.Docs]]
deps = ["HTTP", "Markdown", "Printf", "YAML"]
path = "/workdir"
uuid = "e1c13cdf-5c0d-472c-a597-c85aecc67ad6"
version = "0.1.0"

[[Documenter]]
[[deps.Documenter]]
deps = ["ANSIColoredPrinters", "Base64", "Dates", "DocStringExtensions", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Test", "Unicode"]
git-tree-sha1 = "39fd748a73dce4c05a9655475e437170d8fb1b67"
uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
version = "0.27.25"

[[ExceptionUnwrapping]]
[[deps.ExceptionUnwrapping]]
deps = ["Test"]
git-tree-sha1 = "e90caa41f5a86296e014e148ee061bd6c3edec96"
uuid = "460bff9d-24e4-43bc-9d9f-a8973cb893f4"
version = "0.1.9"

[[HTTP]]
[[deps.HTTP]]
deps = ["Base64", "CodecZlib", "ConcurrentUtilities", "Dates", "ExceptionUnwrapping", "Logging", "LoggingExtras", "MbedTLS", "NetworkOptions", "OpenSSL", "Random", "SimpleBufferStream", "Sockets", "URIs", "UUIDs"]
git-tree-sha1 = "5eab648309e2e060198b45820af1a37182de3cce"
uuid = "cd3eb016-35fb-5094-929b-558a96fad6f3"
version = "1.10.0"

[[IOCapture]]
[[deps.IOCapture]]
deps = ["Logging", "Random"]
git-tree-sha1 = "d75853a0bdbfb1ac815478bacd89cd27b550ace6"
uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89"
version = "0.2.3"

[[InteractiveUtils]]
[[deps.InteractiveUtils]]
deps = ["Markdown"]
uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240"

[[JLLWrappers]]
[[deps.JLLWrappers]]
deps = ["Artifacts", "Preferences"]
git-tree-sha1 = "7e5d6779a1e09a36db2a7b6cff50942a0a7d0fca"
uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210"
version = "1.5.0"

[[JSON]]
[[deps.JSON]]
deps = ["Dates", "Mmap", "Parsers", "Unicode"]
git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a"
uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
version = "0.21.4"

[[LibGit2]]
[[deps.LibGit2]]
deps = ["Base64", "NetworkOptions", "Printf", "SHA"]
uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"

[[Libdl]]
[[deps.Libdl]]
uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb"

[[Libiconv_jll]]
[[deps.Libiconv_jll]]
deps = ["Artifacts", "JLLWrappers", "Libdl"]
git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175"
uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531"
version = "1.17.0+0"

[[Logging]]
[[deps.Logging]]
uuid = "56ddb016-857b-54e1-b83d-db4d58db5568"

[[LoggingExtras]]
[[deps.LoggingExtras]]
deps = ["Dates", "Logging"]
git-tree-sha1 = "c1dd6d7978c12545b4179fb6153b9250c96b0075"
uuid = "e6f89c97-d47a-5376-807f-9c37f3926c36"
version = "1.0.3"

[[Markdown]]
[[deps.Markdown]]
deps = ["Base64"]
uuid = "d6f4376e-aef5-505a-96c1-9c027394607a"

[[MbedTLS]]
[[deps.MbedTLS]]
deps = ["Dates", "MbedTLS_jll", "MozillaCACerts_jll", "Random", "Sockets"]
git-tree-sha1 = "03a9b9718f5682ecb107ac9f7308991db4ce395b"
uuid = "739be429-bea8-5141-9913-cc70e7f3736d"
version = "1.1.7"

[[MbedTLS_jll]]
[[deps.MbedTLS_jll]]
deps = ["Artifacts", "Libdl"]
uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1"
version = "2.28.2+0"

[[Mmap]]
[[deps.Mmap]]
uuid = "a63ad114-7e13-5084-954f-fe012c677804"

[[MozillaCACerts_jll]]
[[deps.MozillaCACerts_jll]]
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
version = "2022.10.11"

[[NetworkOptions]]
[[deps.NetworkOptions]]
uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908"
version = "1.2.0"

[[OpenSSL]]
[[deps.OpenSSL]]
deps = ["BitFlags", "Dates", "MozillaCACerts_jll", "OpenSSL_jll", "Sockets"]
git-tree-sha1 = "51901a49222b09e3743c65b8847687ae5fc78eb2"
uuid = "4d8831e6-92b7-49fb-bdf8-b643e874388c"
version = "1.4.1"

[[OpenSSL_jll]]
[[deps.OpenSSL_jll]]
deps = ["Artifacts", "JLLWrappers", "Libdl"]
git-tree-sha1 = "ceeda72c9fd6bbebc4f4f598560789145a8b6c4c"
uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95"
version = "3.0.11+0"

[[Parsers]]
[[deps.Parsers]]
deps = ["Dates", "PrecompileTools", "UUIDs"]
git-tree-sha1 = "716e24b21538abc91f6205fd1d8363f39b442851"
uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0"
version = "2.7.2"

[[PrecompileTools]]
[[deps.PrecompileTools]]
deps = ["Preferences"]
git-tree-sha1 = "03b4c25b43cb84cee5c90aa9b5ea0a78fd848d2f"
uuid = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
version = "1.2.0"

[[Preferences]]
[[deps.Preferences]]
deps = ["TOML"]
git-tree-sha1 = "00805cd429dcb4870060ff49ef443486c262e38e"
uuid = "21216c6a-2e73-6563-6e65-726566657250"
version = "1.4.1"

[[Printf]]
[[deps.Printf]]
deps = ["Unicode"]
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"

[[REPL]]
[[deps.REPL]]
deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"]
uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"

[[Random]]
[[deps.Random]]
deps = ["SHA", "Serialization"]
uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"

[[SHA]]
[[deps.SHA]]
uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce"
version = "0.7.0"

[[Serialization]]
[[deps.Serialization]]
uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b"

[[SimpleBufferStream]]
[[deps.SimpleBufferStream]]
git-tree-sha1 = "874e8867b33a00e784c8a7e4b60afe9e037b74e1"
uuid = "777ac1f9-54b0-4bf8-805c-2214025038e7"
version = "1.1.0"

[[Sockets]]
[[deps.Sockets]]
uuid = "6462fe0b-24de-5631-8697-dd941f90decc"

[[StringEncodings]]
[[deps.StringEncodings]]
deps = ["Libiconv_jll"]
git-tree-sha1 = "b765e46ba27ecf6b44faf70df40c57aa3a547dcb"
uuid = "69024149-9ee7-55f6-a4c4-859efe599b68"
version = "0.3.7"

[[TOML]]
[[deps.TOML]]
deps = ["Dates"]
uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
version = "1.0.3"

[[Test]]
[[deps.Test]]
deps = ["InteractiveUtils", "Logging", "Random", "Serialization"]
uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[[TranscodingStreams]]
[[deps.TranscodingStreams]]
deps = ["Random", "Test"]
git-tree-sha1 = "9a6ae7ed916312b41236fcef7e0af564ef934769"
uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
version = "0.9.13"

[[URIs]]
[[deps.URIs]]
git-tree-sha1 = "b7a5e99f24892b6824a954199a45e9ffcc1c70f0"
uuid = "5c2747f8-b7ea-4ff2-ba2e-563bfd36b1d4"
version = "1.5.0"

[[UUIDs]]
[[deps.UUIDs]]
deps = ["Random", "SHA"]
uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"

[[Unicode]]
[[deps.Unicode]]
uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5"

[[YAML]]
[[deps.YAML]]
deps = ["Base64", "Dates", "Printf", "StringEncodings"]
git-tree-sha1 = "e6330e4b731a6af7959673621e91645eb1356884"
uuid = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
version = "0.4.9"

[[Zlib_jll]]
[[deps.Zlib_jll]]
deps = ["Libdl"]
uuid = "83775a58-1f1d-513f-b197-d71354ab007a"
version = "1.2.13+0"
6 changes: 3 additions & 3 deletions docs/src/assets/terminalizer/allocate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -213,16 +213,16 @@ records:
- delay: 18
content: ' \"description\": \"Compute for the very large masses\",\n \"id\": \"c1-xlarge-x86\",\n \"name\": \"c1-xlarge-x86\"\n },\n \"state\": {\n \"description\": \"\",\n \"value\": \"\"\n },\n \"tags\":'
- delay: 17
content: " [\\n \\\"machine.metal-pod.io/network.primary.asn=4200056321\\\",\\n \\\"machine.metal-pod.io/rack=fra-equ01-rack01\\\",\\n \\\"machine.metal-pod.io/chassis=C217BAH31AG0535\\\"\\n ]\\n}\" \e[32mcaller\e[0m=wait.go:51"
content: " [\\n \\\"machine.metal-stack.io/network.primary.asn=4200056321\\\",\\n \\\"machine.metal-stack.io/rack=fra-equ01-rack01\\\",\\n \\\"machine.metal-stack.io/chassis=C217BAH31AG0535\\\"\\n ]\\n}\" \e[32mcaller\e[0m=wait.go:51"
- delay: 18
content: "\r\n\e[32mINFO\e[0m[09-21|12:45:04] stopped waiting got \e[32mmachine\e[0m=\"{Allocation:0xc00030a2d0 Changed:0xc0003ee630 Created:0xc0003ee640 Description: Events:0xc000576390 Hardware:"
- delay: 17
content: >-
0xc0006f4000 ID:0xc0003ee8f0 Ledstate:0xc0003ee900 Liveliness:0xc0003ee930
Name: Partition:0xc0000c4b40 Rackid:0xc0003ee970 Size:0xc000236320
State:0xc0003ee9f0 Tags:[machine.metal-pod.io/network.prim
State:0xc0003ee9f0 Tags:[machine.metal-stack.io/network.prim
- delay: 18
content: "ary.asn=4200056321 machine.metal-pod.io/rack=fra-equ01-rack01 machine.metal-pod.io/chassis=C217BAH31AG0535]}\" \e[32mcaller\e[0m=wait.go:58\r\n\e[32mINFO\e[0m[09-21|12:45:04] getdisk "
content: "ary.asn=4200056321 machine.metal-stack.io/rack=fra-equ01-rack01 machine.metal-stack.io/chassis=C217BAH31AG0535]}\" \e[32mcaller\e[0m=wait.go:58\r\n\e[32mINFO\e[0m[09-21|12:45:04] getdisk "
- delay: 17
content: " \e[32mimageID\e[0m=ubuntu-19.04 \e[32mcaller\e[0m=disk.go:206\r\n\e[32mINFO\e[0m[09-21|12:45:04] event \e[32mevent\e[0m=0xc0003eebc0 \e[32mmessage\e[0m=\"start installat"
- delay: 16
Expand Down
6 changes: 3 additions & 3 deletions docs/src/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ One major ambition of metal-stack is to follow the idea of [microservices](https

### Programming Languages

We are generally open to write code in any language that fits best to the function of the software. However, we encourage [golang](https://en.wikipedia.org/wiki/Go_(programming_language)) to be the main language of metal-stack as we think that it makes development faster when not establishing too many different languages in our architecture. Reason for this is that we are striving for consistent behavior of the microservices, similar to what has been described for the Twelve-Factor App (see https://12factor.net/). We help enforcing unified behavior by allowing a small layer of shared code for every programming language. We will refer to this shared code as "libraries" for the rest of this document.
We are generally open to write code in any language that fits best to the function of the software. However, we encourage [golang](https://en.wikipedia.org/wiki/Go_(programming_language)) to be the main language of metal-stack as we think that it makes development faster when not establishing too many different languages in our architecture. Reason for this is that we are striving for consistent behavior of the microservices, similar to what has been described for the Twelve-Factor App (see [12 Factor](https://12factor.net/)). We help enforcing unified behavior by allowing a small layer of shared code for every programming language. We will refer to this shared code as "libraries" for the rest of this document.

### Artifacts

Expand Down Expand Up @@ -91,15 +91,15 @@ Development follows the official guide to:
- Write clear, idiomatic Go code[^2]
- Learn from mistakes that must not be repeated[^3]
- Apply appropriate names to your artifacts:
- [https://talks.golang.org/2014/names.slide#1](https://talks.golang.org/2014/names.slide#1)
- [https://go.dev/talks/2014/names.slide](https://go.dev/talks/2014/names.slide)
- [https://go.dev/blog/package-names](https://go.dev/blog/package-names)
- [https://go.dev/doc/effective_go#names](https://go.dev/doc/effective_go#names)
- Enable others to understand the reasoning of non-trivial code sequences by applying a meaningful documentation.

#### Development Decisions

- **Dependency Management** by using Go modules
- **Build and Test Automation** by using [GNU Make](https://linux.die.net/man/1/make).
- **Build and Test Automation** by using [GNU Make](https://man7.org/linux/man-pages/man1/make.1p.html).
- **End-user APIs** should consider using go-swagger and [Go-Restful](https://github.com/emicklei/go-restful)
**Technical APIs** should consider using [grpc](https://grpc.io/)

Expand Down
4 changes: 2 additions & 2 deletions docs/src/development/proposals/MEP1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,15 @@ In order to replicate certain data which must be available across all partitions
Postgres does not have a multi datacenter with replication in both directions, it just can make the remote instance store the same data.
- CockroachDB

Is a Postgresql compatible database enginge on the wire. CockroachDB gives you both, ACID and geo replication with writes allowed from all connected members. It is even possible to configure [Follow the Workload](https://www.cockroachlabs.com/docs/stable/topology-follow-the-workload.html) and [Geo Partitioning and Replication](https://www.cockroachlabs.com/docs/v19.2/topology-geo-partitioned-replicas.html#main-content).
Is a Postgresql compatible database enginge on the wire. CockroachDB gives you both, ACID and geo replication with writes allowed from all connected members. It is even possible to configure [Follow the Workload](https://www.cockroachlabs.com/docs/stable/topology-follow-the-workload) and [Geo Partitioning and Replication](https://www.cockroachlabs.com/docs/v19.2/topology-geo-partitioned-replicas).

If we migrate all metal-api entities to be stored the same way we store masterdata, we could use cockroachdb to store all metal entities in one ore more databases spread across all partitions and still ensure consistency and high availability.

A simple setup how this would look like is shown here.

![Simple CockroachDB setup](Distributed.png)

go-ipam was modified in a example PR here: https://github.com/metal-pod/go-ipam/pull/17
go-ipam was modified in a example PR here: [PR 17](https://github.com/metal-stack/go-ipam/pull/17)

### API Access

Expand Down
Loading

0 comments on commit 940ffb8

Please sign in to comment.